pub struct GeneratorClient {
client: Client,
}
Fields§
§client: Client
Implementations§
Source§impl GeneratorClient
impl GeneratorClient
fn new(client: Client) -> Self
Sourcepub fn password(
&self,
input: PasswordGeneratorRequest,
) -> Result<String, PasswordError>
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(())
}
Sourcepub fn passphrase(
&self,
input: PassphraseGeneratorRequest,
) -> Result<String, PassphraseError>
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(())
}
Source§impl GeneratorClient
impl GeneratorClient
Sourcepub async fn username(
&self,
input: UsernameGeneratorRequest,
) -> Result<String, UsernameError>
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§
Source§impl From<GeneratorClient> for JsValue
impl From<GeneratorClient> for JsValue
Source§fn from(value: GeneratorClient) -> Self
fn from(value: GeneratorClient) -> Self
Converts to this type from the input type.
Source§impl FromWasmAbi for GeneratorClient
impl FromWasmAbi for GeneratorClient
Source§impl IntoWasmAbi for GeneratorClient
impl IntoWasmAbi for GeneratorClient
Source§impl LongRefFromWasmAbi for GeneratorClient
impl LongRefFromWasmAbi for GeneratorClient
Source§impl OptionFromWasmAbi for GeneratorClient
impl OptionFromWasmAbi for GeneratorClient
Source§impl OptionIntoWasmAbi for GeneratorClient
impl OptionIntoWasmAbi for GeneratorClient
Source§impl RefFromWasmAbi for GeneratorClient
impl RefFromWasmAbi for GeneratorClient
Source§type Anchor = RcRef<GeneratorClient>
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.Source§impl RefMutFromWasmAbi for GeneratorClient
impl RefMutFromWasmAbi for GeneratorClient
Source§impl TryFromJsValue for GeneratorClient
impl TryFromJsValue for GeneratorClient
Source§impl VectorFromWasmAbi for GeneratorClient
impl VectorFromWasmAbi for GeneratorClient
type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi
unsafe fn vector_from_abi(js: Self::Abi) -> Box<[GeneratorClient]>
Source§impl VectorIntoJsValue for GeneratorClient
impl VectorIntoJsValue for GeneratorClient
fn vector_into_jsvalue(vector: Box<[GeneratorClient]>) -> JsValue
Source§impl VectorIntoWasmAbi for GeneratorClient
impl VectorIntoWasmAbi for GeneratorClient
type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi
fn vector_into_abi(vector: Box<[GeneratorClient]>) -> Self::Abi
Source§impl WasmDescribe for GeneratorClient
impl WasmDescribe for GeneratorClient
impl SupportsConstructor for GeneratorClient
impl SupportsInstanceProperty for GeneratorClient
impl SupportsStaticProperty for GeneratorClient
Auto Trait Implementations§
impl Freeze for GeneratorClient
impl !RefUnwindSafe for GeneratorClient
impl Send for GeneratorClient
impl Sync for GeneratorClient
impl Unpin for GeneratorClient
impl !UnwindSafe for GeneratorClient
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
§impl<T> CompatExt for T
impl<T> CompatExt for T
§impl<T, UT> HandleAlloc<UT> for T
impl<T, UT> HandleAlloc<UT> for T
§fn new_handle(value: Arc<T>) -> Handle
fn new_handle(value: Arc<T>) -> Handle
Create a new handle for an Arc value Read more
§unsafe fn clone_handle(handle: Handle) -> Handle
unsafe fn clone_handle(handle: Handle) -> Handle
Clone a handle Read more
§unsafe fn consume_handle(handle: Handle) -> Arc<T>
unsafe fn consume_handle(handle: Handle) -> Arc<T>
Consume a handle, getting back the initial
Arc<>
Read more§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
impl<T> ReturnWasmAbi for Twhere
T: IntoWasmAbi,
Source§type Abi = <T as IntoWasmAbi>::Abi
type Abi = <T as IntoWasmAbi>::Abi
Same as
IntoWasmAbi::Abi
Source§fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
fn return_abi(self) -> <T as ReturnWasmAbi>::Abi
Same as
IntoWasmAbi::into_abi
, except that it may throw and never
return in the case of Err
.