Struct dittolive_ditto::auth::authenticator::DittoAuthenticator
source · [−]pub struct DittoAuthenticator { /* private fields */ }
Expand description
Handle to trigger authentication requests
Implementations
sourceimpl DittoAuthenticator
impl DittoAuthenticator
pub fn new() -> Self
sourcepub fn login_with_token_and_feedback(
&self,
token: &str,
provider: &str
) -> Result<AuthenticationClientFeedback, DittoError>
pub fn login_with_token_and_feedback(
&self,
token: &str,
provider: &str
) -> Result<AuthenticationClientFeedback, DittoError>
Asks the Ditto
instance to make an auth request to the configured
Identity
’s auth URL with a single token parameter.
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 thetoken
and contact your Auth service
sourcepub fn logout<R>(
&self,
cleanup: impl FnOnce(Ditto) -> R
) -> Result<R, DittoError>
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.
sourcepub fn is_authenticated(&self) -> bool
pub fn is_authenticated(&self) -> bool
Query whether Ditto has a valid authentication token.
This will only be true
when using an
OnlineWithAuthentication
identity, after a
successful login. If the authentication token is allowed to expire then it will return
false
instead.
sourcepub fn user_id(&self) -> Option<String>
pub fn user_id(&self) -> Option<String>
The currently logged-in user ID.
This will return None
if there is no valid authentication or an
OnlineWithAuthentication
identity is not being
used.
Trait Implementations
sourceimpl Clone for DittoAuthenticator
impl Clone for DittoAuthenticator
sourcefn clone(&self) -> DittoAuthenticator
fn clone(&self) -> DittoAuthenticator
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreAuto Trait Implementations
impl !RefUnwindSafe for DittoAuthenticator
impl Send for DittoAuthenticator
impl Sync for DittoAuthenticator
impl Unpin for DittoAuthenticator
impl !UnwindSafe for DittoAuthenticator
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> CompatExt for T
impl<T> CompatExt for T
fn compat_ref(&self) -> Compat<&T>
fn compat_ref(&self) -> Compat<&T>
Applies the [
Compat
] adapter by shared reference. Read morefn compat_mut(&mut self) -> Compat<&mut T>
fn compat_mut(&mut self) -> Compat<&mut T>
Applies the [
Compat
] adapter by mutable reference. Read more