Struct GeneratorClient 

pub struct GeneratorClient {
    client: Client,
}

Fields

client: Client

Implementations

impl GeneratorClient

pub fn password( &self, input: PasswordGeneratorRequest, ) -> Result<String, PasswordError>

Generates a random password.

The character sets and password length can be customized using the input parameter.

Examples

use bitwarden_core::Client;
use bitwarden_generators::{GeneratorClientsExt, PassphraseError, PasswordGeneratorRequest};

async fn test() -> Result<(), PassphraseError> {
    let input = PasswordGeneratorRequest {
        lowercase: true,
        uppercase: true,
        numbers: true,
        length: 20,
        ..Default::default()
    };
    let password = Client::new(None).generator().password(input).unwrap();
    println!("{}", password);
    Ok(())
}

pub fn password_rules( &self, rules: String, ) -> Result<PasswordGeneratorRequest, PasswordRulesError>

Parses an HTML passwordrules attribute string into a [PasswordGeneratorRequest].

The returned request can be passed to GeneratorClient::password to produce a password that satisfies the website’s declared constraints.

pub fn passphrase( &self, input: PassphraseGeneratorRequest, ) -> Result<String, PassphraseError>

Generates a random passphrase. A passphrase is a combination of random words separated by a character. An example of passphrase is correct horse battery staple.

The number of words and their case, the word separator, and the inclusion of a number in the passphrase can be customized using the input parameter.

Examples

use bitwarden_core::Client;
use bitwarden_generators::{GeneratorClientsExt, PassphraseError, PassphraseGeneratorRequest};

async fn test() -> Result<(), PassphraseError> {
    let input = PassphraseGeneratorRequest {
        num_words: 4,
        ..Default::default()
    };
    let passphrase = Client::new(None).generator().passphrase(input).unwrap();
    println!("{}", passphrase);
    Ok(())
}

impl GeneratorClient

pub async fn username( &self, input: UsernameGeneratorRequest, ) -> Result<String, UsernameError>

Generates a random username. There are different username generation strategies, which can be customized using the input parameter.

Note that most generation strategies will be executed on the client side, but Forwarded will use third-party services, which may require a specific setup or API key.

use bitwarden_core::Client;
use bitwarden_generators::{GeneratorClientsExt, UsernameError, UsernameGeneratorRequest};

async fn test() -> Result<(), UsernameError> {
    let input = UsernameGeneratorRequest::Word {
        capitalize: true,
        include_number: true,
    };
    let username = Client::new(None).generator().username(input).await.unwrap();
    println!("{}", username);
    Ok(())
}

Trait Implementations

impl From<GeneratorClient> for JsValue

fn from(value: GeneratorClient) -> JsValue

Converts to this type from the input type.

impl FromWasmAbi for GeneratorClient

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> GeneratorClient

Recover a Self from Self::Abi.

impl IntoWasmAbi for GeneratorClient

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for GeneratorClient

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<GeneratorClient>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi( js: <GeneratorClient as LongRefFromWasmAbi>::Abi, ) -> <GeneratorClient as LongRefFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for GeneratorClient

fn is_none(abi: &<GeneratorClient as FromWasmAbi>::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for GeneratorClient

fn none() -> <GeneratorClient as IntoWasmAbi>::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for GeneratorClient

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<GeneratorClient>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi( js: <GeneratorClient as RefFromWasmAbi>::Abi, ) -> <GeneratorClient as RefFromWasmAbi>::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for GeneratorClient

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<GeneratorClient>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi( js: <GeneratorClient as RefMutFromWasmAbi>::Abi, ) -> <GeneratorClient as RefMutFromWasmAbi>::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for GeneratorClient

fn try_from_js_value(value: JsValue) -> Result<GeneratorClient, JsValue>

Performs the conversion.

fn try_from_js_value_ref(value: &JsValue) -> Option<GeneratorClient>

Performs the conversion.

impl VectorFromWasmAbi for GeneratorClient

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi( js: <GeneratorClient as VectorFromWasmAbi>::Abi, ) -> Box<[GeneratorClient]>

impl VectorIntoWasmAbi for GeneratorClient

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi( vector: Box<[GeneratorClient]>, ) -> <GeneratorClient as VectorIntoWasmAbi>::Abi