Struct dittolive_ditto::auth::DittoAuthenticator

source · [−]

pub struct DittoAuthenticator { /* private fields */ }

Expand description

Handle to trigger actual authentication requests

Implementations

impl DittoAuthenticator

pub fn new(auth_client: Arc<BoxedAuthClient>) -> Self

pub fn login_with_token_and_feedback(
    &self,
    token: &str,
    provider: &str
) -> Result<AuthenticationClientFeedback, DittoError>

Asks the Ditto AuthClient to make an Auth Request to the configured Identity’s auth url with a single token paramater.

token - An auth or API token you have configured.
provider - The name of an authentication provider web hook you have configured in Ditto Cloud, which will accept the token and contact your Auth service

pub fn logout<R>(
&self,
cleanup: impl FnOnce(Ditto) -> R
) -> Result<R, DittoError>

Log out of Ditto Shutdown all replication sessions and remove any cached authentication credentials. This does not remove the local data store.

pub fn is_authenticated(&self) -> bool

Query whether Ditto has a valid authentication token.

This will only be true when using an Online or an OnlineWithAuthentication identity, after a successful login. If the authentication token is allowed to expire then it will return false instead.

pub fn user_id(&self) -> Option<String>

The currently logged-in user ID.

This will return None if there is no valid authentication or OnlineWithAuthentication/Online mode is not being used.

Trait Implementations

impl Clone for DittoAuthenticator

fn clone(&self) -> DittoAuthenticator

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

impl DiskUser for DittoAuthenticator

fn ditto_component() -> FsComponent

Specify which component’s file system is being monitored

fn ditto(&self) -> Arc<BoxedDitto>

Return a pointer to Ditto

fn disk_usage_exec(&self) -> DiskUsageChild

Return the tree representation of the ditto disk usage of the component

fn disk_usage_observe(
&self,
callback: impl Fn(DiskUsageChild) + 'static + Send + Sync
) -> Arc<Mutex<DiskUsageObserver>>

Register a callback to monitor the disk usage of the component

Auto Trait Implementations

impl !RefUnwindSafe for DittoAuthenticator

impl Send for DittoAuthenticator

impl Sync for DittoAuthenticator

impl Unpin for DittoAuthenticator

impl !UnwindSafe for DittoAuthenticator

Blanket Implementations

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

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

const: unstable · source

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

pub fn from(t: T) -> T

Returns the argument unchanged.

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

const: unstable · source

pub fn into(self) -> U

Calls U::from(self).

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

impl<T> ManuallyDropMut for T

type Ret = ManuallyDrop<T>

pub fn manually_drop_mut(&' mut self) -> &' mut ManuallyDrop<T>

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

fn to<T>(self) -> T where
Self: Into<T>,

Converts to T by calling Into<T>::into.

fn try_to<T>(self) -> Result<T, Self::Error> where
Self: TryInto<T>,

Tries to convert to T by calling TryInto<T>::try_into.

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

type Owned = T

The resulting type after obtaining ownership.

pub fn to_owned(&self) -> T

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

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

🔬 This is a nightly-only experimental API. (toowned_clone_into)

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

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

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

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

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

pub fn vzip(self) -> V