Struct PassphraseGeneratorRequest 

pub struct PassphraseGeneratorRequest {
    pub num_words: u8,
    pub word_separator: String,
    pub capitalize: bool,
    pub include_number: bool,
}

Passphrase generator request options.

Fields

num_words: u8

Number of words in the generated passphrase. This value must be between 3 and 20.

word_separator: String

Character separator between words in the generated passphrase. The value cannot be empty.

capitalize: bool

When set to true, capitalize the first letter of each word in the generated passphrase.

include_number: bool

When set to true, include a number at the end of one of the words in the generated passphrase.

Implementations

impl PassphraseGeneratorRequest

fn validate_options( self, ) -> Result<ValidPassphraseGeneratorOptions, PassphraseError>

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

Trait Implementations

impl<UT> ConvertError<UT> for PassphraseGeneratorRequest

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

impl Debug for PassphraseGeneratorRequest

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

Formats the value using the given formatter.

impl Default for PassphraseGeneratorRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PassphraseGeneratorRequest

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 PassphraseGeneratorRequest

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 PassphraseGeneratorRequest

Available on crate feature wasm only.

type Wire = Ts<PassphraseGeneratorRequest>

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 PassphraseGeneratorRequest

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 PassphraseGeneratorRequest

type FfiType = <PassphraseGeneratorRequest 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 PassphraseGeneratorRequest

type LiftType = PassphraseGeneratorRequest

impl<UT> LiftReturn<UT> for PassphraseGeneratorRequest

type ReturnType = <PassphraseGeneratorRequest 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 PassphraseGeneratorRequest

type FfiType = <PassphraseGeneratorRequest 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 PassphraseGeneratorRequest

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return

impl<UT> LowerReturn<UT> for PassphraseGeneratorRequest

type ReturnType = <PassphraseGeneratorRequest 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 PassphraseGeneratorRequest

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 PassphraseGeneratorRequest

Available on crate feature wasm only.

type Wire = Ts<PassphraseGeneratorRequest>

The type JavaScript actually receives.

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

Converts the Rust value into the wire value.

impl Tsify for PassphraseGeneratorRequest

const DECL: &'static str = "/**\n * Passphrase generator request options.\n */\nexport interface PassphraseGeneratorRequest {\n /**\n * Number of words in the generated passphrase.\n * This value must be between 3 and 20.\n */\n numWords: number;\n /**\n * Character separator between words in the generated passphrase. The value cannot be empty.\n */\n wordSeparator: string;\n /**\n * When set to true, capitalize the first letter of each word in the generated passphrase.\n */\n capitalize: boolean;\n /**\n * When set to true, include a number at the end of one of the words in the generated\n * passphrase.\n */\n includeNumber: boolean;\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 PassphraseGeneratorRequest

const TYPE_ID_META: MetadataBuffer