Enum UnlockMethod 

pub enum UnlockMethod {
    Legacy(InitUserCryptoRequest),
    SessionKey(SessionKey),
}

The unlock factor passed to UnlockClient::unlock.

Variants

Legacy(InitUserCryptoRequest)

Unlock by initializing the user’s crypto state from an [InitUserCryptoRequest], as CryptoClient::initialize_user_crypto does.

SessionKey(SessionKey)

Unlock using a session key previously obtained from UnlockClient::generate_session_key.

Only the CLI unlocks with a session key, so this variant is not part of the WASM or UniFFI surface. serde(skip) keeps it out of the generated TypeScript type.

Trait Implementations

impl<'de> Deserialize<'de> for UnlockMethod

fn deserialize<__D>( __deserializer: __D, ) -> Result<UnlockMethod, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl FromWasmAbi for UnlockMethod

where UnlockMethod: 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: <UnlockMethod as FromWasmAbi>::Abi) -> UnlockMethod

Recover a Self from Self::Abi.

impl IntoWasmAbi for &UnlockMethod

where UnlockMethod: Serialize,

type Abi = <JsType as IntoWasmAbi>::Abi

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

fn into_abi(self) -> <&UnlockMethod as IntoWasmAbi>::Abi

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

impl IntoWasmAbi for UnlockMethod

where UnlockMethod: Serialize,

type Abi = <JsType as IntoWasmAbi>::Abi

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

fn into_abi(self) -> <UnlockMethod as IntoWasmAbi>::Abi

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

impl OptionFromWasmAbi for UnlockMethod

where UnlockMethod: DeserializeOwned,

fn is_none(js: &<UnlockMethod as FromWasmAbi>::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 UnlockMethod

where UnlockMethod: Serialize,

fn none() -> <UnlockMethod as IntoWasmAbi>::Abi

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

impl RefFromWasmAbi for UnlockMethod

where UnlockMethod: DeserializeOwned,

type Abi = <JsType as RefFromWasmAbi>::Abi

The Wasm ABI type references to Self are recovered from.

type Anchor = SelfOwner<UnlockMethod>

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: <UnlockMethod as RefFromWasmAbi>::Abi, ) -> <UnlockMethod as RefFromWasmAbi>::Anchor

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

impl Serialize for UnlockMethod

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Tsify for UnlockMethod

const DECL: &'static str = "/**\n * The unlock factor passed to [`UnlockClient::unlock`].\n */\nexport type UnlockMethod = { legacy: InitUserCryptoRequest };"

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 VectorFromWasmAbi for UnlockMethod

where UnlockMethod: DeserializeOwned,

type Abi = <JsType as VectorFromWasmAbi>::Abi

unsafe fn vector_from_abi( js: <UnlockMethod as VectorFromWasmAbi>::Abi, ) -> Box<[UnlockMethod]>

impl VectorIntoWasmAbi for UnlockMethod

where UnlockMethod: Serialize,

type Abi = <JsType as VectorIntoWasmAbi>::Abi

fn vector_into_abi( vector: Box<[UnlockMethod]>, ) -> <UnlockMethod as VectorIntoWasmAbi>::Abi