Skip to main content

StateBridgeClient

Struct StateBridgeClient 

Source
pub struct StateBridgeClient {
    pub(crate) client: Client,
}
Expand description

Client for interacting with the key-management state bridge. This is used to read and write state held by the clients

Fields§

§client: Client

Implementations§

Source§

impl StateBridgeClient

Source

pub fn is_bridge_registered(&self) -> bool

Returns true if a state bridge implementation has been registered.

Source

pub fn register_bridge( &self, bridge_impl: Box<dyn StateBridgeImpl + Send + Sync>, )

Registers a bridge implementation used to read and write temporary key-management state.

Source§

impl StateBridgeClient

Source

pub fn register_bridge_impl(&self, bridge_impl: Arc<dyn StateBridgeForeignImpl>)

Registers the host-supplied state bridge implementation.

Source§

impl StateBridgeClient

Source

pub async fn set_user_key(&self, value: &SymmetricCryptoKey)

Sets the user_key value in client-managed state.

Source

pub async fn get_user_key(&self) -> Option<SymmetricCryptoKey>

Gets the user_key value from client-managed state, if available.

Source

pub async fn clear_user_key(&self)

Clears the user_key value from client-managed state.

Source

pub async fn set_user_key_id(&self, value: &KeyId)

Sets the user_key_id value in client-managed state.

Source

pub async fn get_user_key_id(&self) -> Option<KeyId>

Gets the user_key_id value from client-managed state, if available.

Source

pub async fn clear_user_key_id(&self)

Clears the user_key_id value from client-managed state.

Source

pub async fn set_persistent_pin_envelope( &self, value: &PasswordProtectedKeyEnvelope, )

Sets the persistent_pin_envelope value in client-managed state.

Source

pub async fn get_persistent_pin_envelope( &self, ) -> Option<PasswordProtectedKeyEnvelope>

Gets the persistent_pin_envelope value from client-managed state, if available.

Source

pub async fn clear_persistent_pin_envelope(&self)

Clears the persistent_pin_envelope value from client-managed state.

Source

pub async fn set_ephemeral_pin_envelope( &self, value: &PasswordProtectedKeyEnvelope, )

Sets the ephemeral_pin_envelope value in client-managed state.

Source

pub async fn get_ephemeral_pin_envelope( &self, ) -> Option<PasswordProtectedKeyEnvelope>

Gets the ephemeral_pin_envelope value from client-managed state, if available.

Source

pub async fn clear_ephemeral_pin_envelope(&self)

Clears the ephemeral_pin_envelope value from client-managed state.

Source

pub async fn set_encrypted_pin(&self, value: &EncString)

Sets the encrypted_pin value in client-managed state.

Source

pub async fn get_encrypted_pin(&self) -> Option<EncString>

Gets the encrypted_pin value from client-managed state, if available.

Source

pub async fn clear_encrypted_pin(&self)

Clears the encrypted_pin value from client-managed state.

Source

pub async fn set_v2_upgrade_token(&self, value: &V2UpgradeToken)

Sets the v2_upgrade_token value in client-managed state.

Source

pub async fn get_v2_upgrade_token(&self) -> Option<V2UpgradeToken>

Gets the v2_upgrade_token value from client-managed state, if available.

Source

pub async fn clear_v2_upgrade_token(&self)

Clears the v2_upgrade_token value from client-managed state.

Source

pub async fn set_account_cryptographic_state( &self, value: &WrappedAccountCryptographicState, )

Sets the account_cryptographic_state value in client-managed state.

Source

pub async fn get_account_cryptographic_state( &self, ) -> Option<WrappedAccountCryptographicState>

Gets the account_cryptographic_state value from client-managed state, if available.

Source

pub async fn clear_account_cryptographic_state(&self)

Clears the account_cryptographic_state value from client-managed state.

Source

pub async fn set_masterpassword_unlock_data( &self, value: &MasterPasswordUnlockData, )

Sets the masterpassword_unlock_data value in client-managed state.

Source

pub async fn get_masterpassword_unlock_data( &self, ) -> Option<MasterPasswordUnlockData>

Gets the masterpassword_unlock_data value from client-managed state, if available.

Source

pub async fn clear_masterpassword_unlock_data(&self)

Clears the masterpassword_unlock_data value from client-managed state.

Source

pub async fn set_webauthn_prf_unlock_data(&self, value: &WebAuthnPrfUnlockData)

Sets the webauthn_prf_unlock_data value in client-managed state.

Source

pub async fn get_webauthn_prf_unlock_data( &self, ) -> Option<WebAuthnPrfUnlockData>

Gets the webauthn_prf_unlock_data value from client-managed state, if available.

Source

pub async fn clear_webauthn_prf_unlock_data(&self)

Clears the webauthn_prf_unlock_data value from client-managed state.

Source

pub async fn set_kdf_config(&self, value: &Kdf)

Sets the kdf_config value in client-managed state.

Source

pub async fn get_kdf_config(&self) -> Option<Kdf>

Gets the kdf_config value from client-managed state, if available.

Source

pub async fn clear_kdf_config(&self)

Clears the kdf_config value from client-managed state.

Source

pub async fn set_v2_encrypted_migrations_grace_period_start( &self, value: &V2EncryptedMigrationsGracePeriodStart, )

Sets the v2_encrypted_migrations_grace_period_start value in client-managed state.

Source

pub async fn get_v2_encrypted_migrations_grace_period_start( &self, ) -> Option<V2EncryptedMigrationsGracePeriodStart>

Gets the v2_encrypted_migrations_grace_period_start value from client-managed state, if available.

Source

pub async fn clear_v2_encrypted_migrations_grace_period_start(&self)

Clears the v2_encrypted_migrations_grace_period_start value from client-managed state.

Trait Implementations§

Source§

impl Clone for StateBridgeClient

Source§

fn clone(&self) -> StateBridgeClient

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl From<StateBridgeClient> for JsValue

Source§

fn from(value: StateBridgeClient) -> Self

Converts to this type from the input type.
Source§

impl FromWasmAbi for StateBridgeClient

Source§

type Abi = u32

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

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi. Read more
Source§

impl IntoWasmAbi for StateBridgeClient

Source§

type Abi = u32

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

fn into_abi(self) -> u32

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

impl<UT> LiftRef<UT> for StateBridgeClient

Source§

impl LongRefFromWasmAbi for StateBridgeClient

Source§

type Abi = u32

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRef<StateBridgeClient>

Same as RefFromWasmAbi::Anchor
Source§

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

Same as RefFromWasmAbi::ref_from_abi
Source§

impl<UT> LowerError<UT> for StateBridgeClient

Source§

fn lower_error(obj: Self) -> RustBuffer

Lower this value for scaffolding function return Read more
Source§

impl<UT> LowerReturn<UT> for StateBridgeClient

Source§

type ReturnType = <Arc<StateBridgeClient> as LowerReturn<UniFfiTag>>::ReturnType

The type that should be returned by scaffolding functions for this type. Read more
Source§

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

Lower the return value from an scaffolding call Read more
§

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

Lower the return value for failed argument lifts Read more
Source§

impl OptionFromWasmAbi for StateBridgeClient

Source§

fn is_none(abi: &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.
Source§

impl OptionIntoWasmAbi for StateBridgeClient

Source§

fn none() -> Self::Abi

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

impl RefFromWasmAbi for StateBridgeClient

Source§

type Abi = u32

The Wasm ABI type references to Self are recovered from.
Source§

type Anchor = RcRef<StateBridgeClient>

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.
Source§

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

Recover a Self::Anchor from Self::Abi. Read more
Source§

impl RefMutFromWasmAbi for StateBridgeClient

Source§

type Abi = u32

Same as RefFromWasmAbi::Abi
Source§

type Anchor = RcRefMut<StateBridgeClient>

Same as RefFromWasmAbi::Anchor
Source§

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

Same as RefFromWasmAbi::ref_from_abi
Source§

impl SupportsConstructor for StateBridgeClient

Source§

impl SupportsInstanceProperty for StateBridgeClient

Source§

impl SupportsStaticProperty for StateBridgeClient

Source§

impl TryFromJsValue for StateBridgeClient

Source§

fn try_from_js_value(value: JsValue) -> Result<Self, JsValue>

Performs the conversion.
Source§

fn try_from_js_value_ref(value: &JsValue) -> Option<Self>

Performs the conversion.
Source§

impl<UT> TypeId<UT> for StateBridgeClient

Source§

const TYPE_ID_META: MetadataBuffer

Source§

impl VectorFromWasmAbi for StateBridgeClient

Source§

impl VectorIntoWasmAbi for StateBridgeClient

Source§

impl WasmDescribe for StateBridgeClient

Source§

impl WasmDescribeVector for StateBridgeClient

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
§

impl<T> Any for T
where T: Any,

§

fn into_any(self: Box<T>) -> Box<dyn Any>

§

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>

§

fn type_name(&self) -> &'static str

§

impl<T> AnySync for T
where T: Any + Send + Sync,

§

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Send + Sync>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
§

impl<T> CompatExt for T

§

fn compat(self) -> Compat<T>
where T: Sized,

Applies the [Compat] adapter by value. Read more
§

fn compat_ref(&self) -> Compat<&T>

Applies the [Compat] adapter by shared reference. Read more
§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the [Compat] adapter by mutable reference. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T, UT> HandleAlloc<UT> for T
where T: Send + Sync,

§

fn new_handle(value: Arc<T>) -> Handle

Create a new handle for an Arc value Read more
§

unsafe fn clone_handle(handle: Handle) -> Handle

Clone a handle Read more
§

unsafe fn consume_handle(handle: Handle) -> Arc<T>

Consume a handle, getting back the initial Arc<> Read more
§

unsafe fn get_arc(handle: Handle) -> Arc<Self>

Get a clone of the Arc<> using a “borrowed” handle. Read more
§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
§

impl<T> PolicyExt for T
where T: ?Sized,

§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] only if self and other return Action::Follow. Read more
§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns [Action::Follow] if either self or other returns Action::Follow. Read more
§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ReturnWasmAbi for T
where T: IntoWasmAbi,

Source§

type Abi = <T as IntoWasmAbi>::Abi

Same as IntoWasmAbi::Abi
Source§

fn return_abi(self) -> <T as ReturnWasmAbi>::Abi

Same as IntoWasmAbi::into_abi, except that it may throw and never return in the case of Err.
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<S, T> Upcast<T> for S
where T: UpcastFrom<S> + ?Sized, S: ?Sized,

Source§

fn upcast(&self) -> &T
where Self: ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider ref type within the Wasm bindgen generics type system. Read more
Source§

fn upcast_into(self) -> T
where Self: Sized + ErasableGeneric, T: Sized + ErasableGeneric<Repr = Self::Repr>,

Perform a zero-cost type-safe upcast to a wider type within the Wasm bindgen generics type system. Read more
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more