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 From<PassphraseGeneratorRequest> for JsValue

where PassphraseGeneratorRequest: Serialize,

fn from(value: PassphraseGeneratorRequest) -> Self

Converts to this type from the input type.

impl FromWasmAbi for PassphraseGeneratorRequest

where Self: DeserializeOwned,

type Abi = <JsType as FromWasmAbi>::Abi

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: Self::Abi) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for PassphraseGeneratorRequest

where PassphraseGeneratorRequest: Serialize,

type Abi = <JsType as IntoWasmAbi>::Abi

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> Self::Abi

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl JsonSchema for PassphraseGeneratorRequest

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(generator: &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 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 OptionFromWasmAbi for PassphraseGeneratorRequest

where Self: DeserializeOwned,

fn is_none(js: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for PassphraseGeneratorRequest

where PassphraseGeneratorRequest: Serialize,

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for PassphraseGeneratorRequest

where Self: DeserializeOwned,

type Abi = <JsType as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = SelfOwner<PassphraseGeneratorRequest>

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.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

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 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

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,

impl<UT> TypeId<UT> for PassphraseGeneratorRequest

const TYPE_ID_META: MetadataBuffer

impl VectorFromWasmAbi for PassphraseGeneratorRequest

where Self: DeserializeOwned,

type Abi = <JsType as VectorFromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[Self]>

impl VectorIntoWasmAbi for PassphraseGeneratorRequest

where PassphraseGeneratorRequest: Serialize,

type Abi = <JsType as VectorIntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[Self]>) -> Self::Abi

impl WasmDescribe for PassphraseGeneratorRequest

fn describe()

impl WasmDescribeVector for PassphraseGeneratorRequest

fn describe_vector()