AuthClientBuilder

ic_auth_client

Struct AuthClientBuilder 

Source 
pub struct AuthClientBuilder { /* private fields */ }
Expand description

Builder for the AuthClient.

Implementations§

Source§

impl AuthClientBuilder

Source

pub fn identity(&mut self, identity: IdentityType) -> &mut Self

An optional identity to use as the base. If not provided, an Ed25519 key pair will be used.

Source

pub fn storage(&mut self, storage: AuthClientStorageType) -> &mut Self

Optional storage with get, set, and remove methods. Currentry only LocalStorage is supported.

Source

pub fn key_type(&mut self, key_type: BaseKeyType) -> &mut Self

The type of key to use for the base key. If not provided, Ed25519 will be used by default.

Source

pub fn idle_options(&mut self, idle_options: IdleOptions) -> &mut Self

Options for handling idle timeouts. If not provided, default options will be used.

Source

pub fn disable_idle(&mut self, disable_idle: bool) -> &mut Self

If set to true, disables the idle timeout functionality.

Source

pub fn disable_default_idle_callback( &mut self, disable_default_idle_callback: bool, ) -> &mut Self

If set to true, disables the default idle timeout callback.

Source

pub fn idle_manager_options( &mut self, idle_manager_options: IdleManagerOptions, ) -> &mut Self

Options for the IdleManager that handles idle timeouts.

Source

pub fn on_idle(&mut self, on_idle: fn()) -> &mut Self

A callback function to be executed when the system becomes idle.

Source

pub fn idle_timeout(&mut self, idle_timeout: u32) -> &mut Self

The duration of inactivity after which the system is considered idle.

Source

pub fn scroll_debounce(&mut self, scroll_debounce: u32) -> &mut Self

A delay for debouncing scroll events.

Source

pub fn capture_scroll(&mut self, capture_scroll: bool) -> &mut Self

A flag indicating whether to capture scroll events.

Source

pub async fn build(&mut self) -> Result<AuthClient, DelegationError>

Builds a new AuthClient.

Trait Implementations§

Source§

impl Default for AuthClientBuilder

Source§

fn default() -> AuthClientBuilder

Returns the “default value” for a type. Read more

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

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: 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
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

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

Source§

type Error = Infallible

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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

impl<T> ErasedDestructor for T
where T: 'static,