bitwarden_generators/
generator_client.rs

1use bitwarden_core::Client;
2#[cfg(feature = "wasm")]
3use wasm_bindgen::prelude::*;
4
5use crate::{
6    passphrase::passphrase, password::password, username::username, PassphraseError,
7    PassphraseGeneratorRequest, PasswordError, PasswordGeneratorRequest, UsernameError,
8    UsernameGeneratorRequest,
9};
10
11#[cfg_attr(feature = "wasm", wasm_bindgen)]
12pub struct GeneratorClient {
13    client: Client,
14}
15
16#[cfg_attr(feature = "wasm", wasm_bindgen)]
17impl GeneratorClient {
18    fn new(client: Client) -> Self {
19        Self { client }
20    }
21
22    /// Generates a random password.
23    ///
24    /// The character sets and password length can be customized using the `input` parameter.
25    ///
26    /// # Examples
27    ///
28    /// ```
29    /// use bitwarden_core::Client;
30    /// use bitwarden_generators::{GeneratorClientsExt, PassphraseError, PasswordGeneratorRequest};
31    ///
32    /// async fn test() -> Result<(), PassphraseError> {
33    ///     let input = PasswordGeneratorRequest {
34    ///         lowercase: true,
35    ///         uppercase: true,
36    ///         numbers: true,
37    ///         length: 20,
38    ///         ..Default::default()
39    ///     };
40    ///     let password = Client::new(None).generator().password(input).unwrap();
41    ///     println!("{}", password);
42    ///     Ok(())
43    /// }
44    /// ```
45    pub fn password(&self, input: PasswordGeneratorRequest) -> Result<String, PasswordError> {
46        password(input)
47    }
48
49    /// Generates a random passphrase.
50    /// A passphrase is a combination of random words separated by a character.
51    /// An example of passphrase is `correct horse battery staple`.
52    ///
53    /// The number of words and their case, the word separator, and the inclusion of
54    /// a number in the passphrase can be customized using the `input` parameter.
55    ///
56    /// # Examples
57    ///
58    /// ```
59    /// use bitwarden_core::Client;
60    /// use bitwarden_generators::{GeneratorClientsExt, PassphraseError, PassphraseGeneratorRequest};
61    ///
62    /// async fn test() -> Result<(), PassphraseError> {
63    ///     let input = PassphraseGeneratorRequest {
64    ///         num_words: 4,
65    ///         ..Default::default()
66    ///     };
67    ///     let passphrase = Client::new(None).generator().passphrase(input).unwrap();
68    ///     println!("{}", passphrase);
69    ///     Ok(())
70    /// }
71    /// ```
72    pub fn passphrase(&self, input: PassphraseGeneratorRequest) -> Result<String, PassphraseError> {
73        passphrase(input)
74    }
75}
76
77impl GeneratorClient {
78    /// Generates a random username.
79    /// There are different username generation strategies, which can be customized using the
80    /// `input` parameter.
81    ///
82    /// Note that most generation strategies will be executed on the client side, but `Forwarded`
83    /// will use third-party services, which may require a specific setup or API key.
84    ///
85    /// ```
86    /// use bitwarden_core::Client;
87    /// use bitwarden_generators::{GeneratorClientsExt, UsernameError, UsernameGeneratorRequest};
88    ///
89    /// async fn test() -> Result<(), UsernameError> {
90    ///     let input = UsernameGeneratorRequest::Word {
91    ///         capitalize: true,
92    ///         include_number: true,
93    ///     };
94    ///     let username = Client::new(None).generator().username(input).await.unwrap();
95    ///     println!("{}", username);
96    ///     Ok(())
97    /// }
98    /// ```
99    pub async fn username(&self, input: UsernameGeneratorRequest) -> Result<String, UsernameError> {
100        username(input, self.client.internal.get_http_client()).await
101    }
102}
103
104pub trait GeneratorClientsExt {
105    fn generator(&self) -> GeneratorClient;
106}
107
108impl GeneratorClientsExt for Client {
109    fn generator(&self) -> GeneratorClient {
110        GeneratorClient::new(self.clone())
111    }
112}
bitwarden_generators/generator_client.rs

bitwarden_generators/
generator_client.rs
