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
impl DeviceCredentials
Sourcepub fn new(
keychain: Arc<StoreKeychain>,
person: Arc<PersonEntries>,
directory: StoreDir,
oauth: Option<OAuthExchange>,
) -> Self
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).
Sourcepub fn write<T>(
&self,
change: impl FnOnce(&CredentialKeychains) -> Result<T, SyncError>,
) -> Result<T, SyncError>
pub fn write<T>( &self, change: impl FnOnce(&CredentialKeychains) -> Result<T, SyncError>, ) -> Result<T, SyncError>
Change committed credentials, serialized with every refresh’s commit.
Sourcepub fn connection(&self) -> Result<Option<ConnectionCredentials>, SyncError>
pub fn connection(&self) -> Result<Option<ConnectionCredentials>, SyncError>
The saved location with these credentials; None when either is absent.
Sourcepub fn location(&self) -> Result<RecordedLocation<StorageConfig>, SyncError>
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).
Sourcepub fn tokens(&self) -> Result<OAuthTokens, SyncError>
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.
Sourcepub fn commit_code(
&self,
code: &RestoreCode,
name: &SavedName,
) -> Result<CredentialRollback, SyncError>
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
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,
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,
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§
impl !Freeze for DeviceCredentials
impl !RefUnwindSafe for DeviceCredentials
impl !UnwindSafe for DeviceCredentials
impl Send for DeviceCredentials
impl Sync for DeviceCredentials
impl Unpin for DeviceCredentials
impl UnsafeUnpin for DeviceCredentials
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
impl<T> ErasedDestructor for Twhere
T: 'static,
§impl<T> Instrument for T
impl<T> Instrument for T
§fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
fn instrument(self, span: Span) -> Instrumented<Self> ⓘ
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
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