Skip to main content

DeviceCredentials

Struct DeviceCredentials 

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

This installation’s committed storage credentials. Every write of them goes through Self::write, so a refresh commits its replacement only while custody still holds the tokens the provider rejected.

Implementations§

Source§

impl DeviceCredentials

Source

pub fn new( keychain: Arc<StoreKeychain>, person: Arc<PersonEntries>, directory: StoreDir, oauth: Option<OAuthExchange>, ) -> Self

Compose once per installation, beside its device-only entries and the person’s entries: for an open store, or for a join from the moment it keeps its sign-in, which the joined store’s handle goes on using (§13.2).

Source

pub fn write<T>( &self, change: impl FnOnce(&CredentialKeychains) -> Result<T, SyncError>, ) -> Result<T, SyncError>

Change committed credentials, serialized with every refresh’s commit.

Source

pub fn connection(&self) -> Result<Option<ConnectionCredentials>, SyncError>

The saved location with these credentials; None when either is absent.

Source

pub fn location(&self) -> Result<RecordedLocation<StorageConfig>, SyncError>

The recorded location, with its labels, and whether this device’s credentials for it are held, as the sync state reads it (§19.1).

Source

pub fn tokens(&self) -> Result<OAuthTokens, SyncError>

The OAuth tokens committed here, which a new connection starts with. Refuses when no OAuth sign-in is committed.

Source

pub fn commit_code( &self, code: &RestoreCode, name: &SavedName, ) -> Result<CredentialRollback, SyncError>

Save the restore code with the store’s name beside the OAuth sign-in committed here, leaving that sign-in as it is: a join publishes this way, since it has kept its sign-in here while it waited, refreshes included (§13.2). Refuses when no OAuth sign-in is committed.

Trait Implementations§

Source§

impl TokenCustody for DeviceCredentials

Source§

fn replace<'life0, 'life1, 'async_trait>( &'life0 self, rejected: &'life1 OAuthTokens, ) -> Pin<Box<dyn Future<Output = Result<OAuthTokens, StorageError>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Replace tokens the provider rejected with HTTP 401. When the held sign-in no longer is rejected (another connection refreshed it, or a new sign-in was committed), return the held one; otherwise refresh once and commit the replacement here before returning it. A failed refresh or commit returns its error and installs nothing.

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
§

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,

§

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

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

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<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
§

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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

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