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>,
    pub custom_required_chars: Option<String>,
    pub custom_allowed_chars: Option<String>,
    pub max_consecutive: 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.

custom_required_chars: Option<String>

Custom characters that must each be available to the generator and from which at least one character is guaranteed to appear in the output. Each character of the string is treated as a member of the custom required set. Non-ASCII-printable characters are silently dropped during validation.

This is primarily used by the HTML passwordrules parser to honor custom required character classes (e.g. required: [!#$]).

custom_allowed_chars: Option<String>

Custom characters that are added to the overall pool of allowed characters, but are not required to appear. Each character of the string is treated as a member of the custom allowed set. Non-ASCII-printable characters are silently dropped during validation.

This is primarily used by the HTML passwordrules parser to honor custom allowed character classes (e.g. allowed: [-_.]).

max_consecutive: Option<u8>

The maximum number of consecutive identical characters allowed in the generated password, as expressed by the HTML passwordrules max-consecutive property. None disables the check; Some(0) is invalid and rejected at request validation. Enforced via re-shuffle with a single-pass repair fallback for degenerate pool sizes.

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 FromWasm for PasswordGeneratorRequest

Available on crate feature wasm only.

type Wire = Ts<PasswordGeneratorRequest>

The type JavaScript actually passes.

fn from_wire(wire: Self::Wire) -> Result<Self, WireError>

Recovers the Rust value from the wire value.

impl JsonSchema for PasswordGeneratorRequest

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

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(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being 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 ToWasm for PasswordGeneratorRequest

Available on crate feature wasm only.

type Wire = Ts<PasswordGeneratorRequest>

The type JavaScript actually receives.

fn to_wire(self) -> Result<Self::Wire, WireError>

Converts the Rust value into the wire value.

impl Tsify for PasswordGeneratorRequest

const DECL: &'static str = "/**\n * Password generator request options.\n */\nexport interface PasswordGeneratorRequest {\n /**\n * Include lowercase characters (a-z).\n */\n lowercase: boolean;\n /**\n * Include uppercase characters (A-Z).\n */\n uppercase: boolean;\n /**\n * Include numbers (0-9).\n */\n numbers: boolean;\n /**\n * Include special characters: ! @ # $ % ^ & *\n */\n special: boolean;\n /**\n * The length of the generated password.\n * Note that the password length must be greater than the sum of all the minimums.\n */\n length: number;\n /**\n * When set to true, the generated password will not contain ambiguous characters.\n * The ambiguous characters are: I, O, l, 0, 1\n */\n avoidAmbiguous: boolean;\n /**\n * The minimum number of lowercase characters in the generated password.\n * When set, the value must be between 1 and 9. This value is ignored if lowercase is false.\n */\n minLowercase: number | undefined;\n /**\n * The minimum number of uppercase characters in the generated password.\n * When set, the value must be between 1 and 9. This value is ignored if uppercase is false.\n */\n minUppercase: number | undefined;\n /**\n * The minimum number of numbers in the generated password.\n * When set, the value must be between 1 and 9. This value is ignored if numbers is false.\n */\n minNumber: number | undefined;\n /**\n * The minimum number of special characters in the generated password.\n * When set, the value must be between 1 and 9. This value is ignored if special is false.\n */\n minSpecial: number | undefined;\n /**\n * Custom characters that must each be available to the generator and from which at least\n * one character is guaranteed to appear in the output. Each character of the string is\n * treated as a member of the custom required set. Non-ASCII-printable characters are\n * silently dropped during validation.\n *\n * This is primarily used by the HTML `passwordrules` parser to honor custom required\n * character classes (e.g. `required: [!#$]`).\n */\n customRequiredChars?: string;\n /**\n * Custom characters that are added to the overall pool of allowed characters, but are not\n * required to appear. Each character of the string is treated as a member of the custom\n * allowed set. Non-ASCII-printable characters are silently dropped during validation.\n *\n * This is primarily used by the HTML `passwordrules` parser to honor custom allowed\n * character classes (e.g. `allowed: [-_.]`).\n */\n customAllowedChars?: string;\n /**\n * The maximum number of consecutive identical characters allowed in the generated password,\n * as expressed by the HTML `passwordrules` `max-consecutive` property. `None` disables\n * the check; `Some(0)` is invalid and rejected at request validation. Enforced via\n * re-shuffle with a single-pass repair fallback for degenerate pool sizes.\n */\n maxConsecutive?: number;\n}"

const SERIALIZATION_CONFIG: SerializationConfig

type JsType = JsType

Must be a type imported through #[wasm_bindgen] extern "C" { .. }. [Ts<T>] is #[repr(transparent)] over this and passes it across the ABI as a plain JS handle, which any other representation would break.

fn into_js(&self) -> Result<Self::JsType, Error>

where Self: Serialize,

fn from_js<T>(js: T) -> Result<Self, Error>

where T: Into<JsValue>, Self: DeserializeOwned,

fn into_ts(&self) -> Result<Ts<Self>, Error>

where Self: Sized + Serialize,

Calls Ts::from_rust on self, returning a Result<Ts<Self>, crate::Error>.

impl<UT> TypeId<UT> for PasswordGeneratorRequest

const TYPE_ID_META: MetadataBuffer