Struct GeneratorClient

pub struct GeneratorClient {
    client: Client,
}

Fields

client: Client

Implementations

impl GeneratorClient

fn new(client: Client) -> Self

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 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(())
}

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(())
}