Struct PasswordGeneratorRequest

pub struct PasswordGeneratorRequest {
    pub lowercase: bool,
    pub uppercase: bool,
    pub numbers: bool,
    pub special: bool,
    pub length: u8,
    pub avoid_ambiguous: bool,
    pub min_lowercase: Option<u8>,
    pub min_uppercase: Option<u8>,
    pub min_number: Option<u8>,
    pub min_special: Option<u8>,
}

Password generator request options.

Fields

lowercase: bool

Include lowercase characters (a-z).

uppercase: bool

Include uppercase characters (A-Z).

numbers: bool

Include numbers (0-9).

special: bool

Include special characters: ! @ # $ % ^ & *

length: u8

The length of the generated password. Note that the password length must be greater than the sum of all the minimums.

avoid_ambiguous: bool

When set to true, the generated password will not contain ambiguous characters. The ambiguous characters are: I, O, l, 0, 1

min_lowercase: Option<u8>

The minimum number of lowercase characters in the generated password. When set, the value must be between 1 and 9. This value is ignored if lowercase is false.

min_uppercase: Option<u8>

The minimum number of uppercase characters in the generated password. When set, the value must be between 1 and 9. This value is ignored if uppercase is false.

min_number: Option<u8>

The minimum number of numbers in the generated password. When set, the value must be between 1 and 9. This value is ignored if numbers is false.

min_special: Option<u8>

The minimum number of special characters in the generated password. When set, the value must be between 1 and 9. This value is ignored if special is false.

Implementations

impl PasswordGeneratorRequest

fn validate_options(self) -> Result<PasswordGeneratorOptions, PasswordError>

Validates the request and returns an immutable struct with valid options to use with the password generator.

Trait Implementations

impl<UT> ConvertError<UT> for PasswordGeneratorRequest

fn try_convert_unexpected_callback_error( e: UnexpectedUniFFICallbackError, ) -> Result<Self>

impl Debug for PasswordGeneratorRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PasswordGeneratorRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PasswordGeneratorRequest

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<UT> FfiConverter<UT> for PasswordGeneratorRequest

const TYPE_ID_META: MetadataBuffer

Type ID metadata, serialized into a [MetadataBuffer].

type FfiType = RustBuffer

The low-level type used for passing values of this type over the FFI.

fn lower(v: Self) -> RustBuffer

Lower a rust value of the target type, into an FFI value of type Self::FfiType.

fn try_lift(buf: RustBuffer) -> Result<Self>

Lift a rust value of the target type, from an FFI value of type Self::FfiType.

fn write(obj: Self, buf: &mut Vec<u8>)

Write a rust value into a buffer, to send over the FFI in serialized form.

fn try_read(buf: &mut &[u8]) -> Result<Self>

Read a rust value from a buffer, received over the FFI in serialized form.

impl JsonSchema for PasswordGeneratorRequest

fn schema_name() -> String

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be re-used where possible using the $ref keyword.

impl<UT> Lift<UT> for PasswordGeneratorRequest

type FfiType = <PasswordGeneratorRequest as FfiConverter<UT>>::FfiType

fn try_lift(v: Self::FfiType) -> Result<Self>

fn try_read(buf: &mut &[u8]) -> Result<Self>

fn try_lift_from_rust_buffer(v: RustBuffer) -> Result<Self, Error>

Convenience method

impl<UT> LiftRef<UT> for PasswordGeneratorRequest

type LiftType = PasswordGeneratorRequest

impl<UT> LiftReturn<UT> for PasswordGeneratorRequest

type ReturnType = <PasswordGeneratorRequest as Lift<UT>>::FfiType

FFI return type for trait interfaces

fn try_lift_successful_return(v: Self::ReturnType) -> Result<Self>

Lift a successfully returned value from a trait interface

fn lift_foreign_return( ffi_return: Self::ReturnType, call_status: RustCallStatus, ) -> Self

Lift a foreign returned value from a trait interface

fn lift_error(_buf: RustBuffer) -> Self

Lift a Rust value for a callback interface method error result

fn handle_callback_unexpected_error(e: UnexpectedUniFFICallbackError) -> Self

Lift a Rust value for an unexpected callback interface error

impl<UT> Lower<UT> for PasswordGeneratorRequest

type FfiType = <PasswordGeneratorRequest as FfiConverter<UT>>::FfiType

fn lower(obj: Self) -> Self::FfiType

fn write(obj: Self, buf: &mut Vec<u8>)

fn lower_into_rust_buffer(obj: Self) -> RustBuffer

Convenience method

impl<UT> LowerError<UT> for PasswordGeneratorRequest

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for PasswordGeneratorRequest

type ReturnType = <PasswordGeneratorRequest as Lower<UT>>::FfiType

The type that should be returned by scaffolding functions for this type.

fn lower_return(v: Self) -> Result<Self::ReturnType, RustCallError>

Lower the return value from an scaffolding call

fn handle_failed_lift( error: LiftArgsError, ) -> Result<Self::ReturnType, RustCallError>

Lower the return value for failed argument lifts

impl Serialize for PasswordGeneratorRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<UT> TypeId<UT> for PasswordGeneratorRequest

const TYPE_ID_META: MetadataBuffer