Struct NetworkAccount

pub struct NetworkAccount { /* private fields */ }

Account with networking capability.

Implementations

impl NetworkAccount

pub async fn stop_listening(&self, origin: &Origin)

Available on crate feature listen only.

Stop listening to a server websocket.

pub async fn listen( &self, origin: &Origin, options: ListenOptions, listener: Option<Sender<(ChangeNotification, RemoteResult<Error>)>>, ) -> Result<(), Error>

Available on crate feature listen only.

Listen for changes on a server websocket.

impl NetworkAccount

pub async fn deactivate(&mut self)

Deactive this account by closing down long-running tasks.

Does not sign out of the account so is similar to moving this account to the background so the data is still accessible.

This can be used when implementing quick account switching to shutdown the websocket and file transfers.

Server remotes are left intact so that making changes will still sync with server(s).

pub async fn activate(&mut self) -> Result<(), Error>

Activate this account by resuming websocket connections and file transfers.

pub fn set_connection_id(&mut self, value: Option<String>)

Set the connection identifier.

pub fn connection_id(&self) -> Option<&str>

Connection identifier.

pub async fn add_server( &mut self, origin: Origin, ) -> Result<Option<RemoteResult<Error>>, Error>

Add a server.

An initial sync is performed with the server and the result includes a possible error encountered during the initial sync.

If a server with the given origin already exists it is overwritten.

pub async fn replace_server( &mut self, old_origin: &Origin, new_origin: Origin, ) -> Result<bool, Error>

Replace a server origin with updated origin information.

pub async fn remove_server( &mut self, origin: &Origin, ) -> Result<Option<RemoteBridge>, Error>

Remove a server.

pub async fn servers(&self) -> HashSet<Origin>

List the origin servers.

Derived from the currently configuted in-memory remotes.

pub async fn recover_remote_folder( &mut self, origin: &Origin, folder_id: &VaultId, ) -> Result<Summary, Error>

Try to recover a folder from a remote origin; it is an error if the folder exists in memory or on disc.

impl NetworkAccount

pub async fn new_unauthenticated( account_id: AccountId, target: BackendTarget, options: NetworkAccountOptions, ) -> Result<Self, Error>

Prepare an account for sign in.

After preparing an account call sign_in to authenticate a user.

pub async fn new_account( account_name: String, passphrase: SecretString, target: BackendTarget, options: NetworkAccountOptions, ) -> Result<Self, Error>

Create a new account with the given name, passphrase and provider.

Uses standard flags for the account builder for more control of the created account use new_account_with_builder().

pub async fn new_account_with_builder( account_name: String, passphrase: SecretString, target: BackendTarget, options: NetworkAccountOptions, builder: impl Fn(AccountBuilder) -> AccountBuilder + Send, ) -> Result<Self, Error>

Create a new account with the given name, passphrase and provider and modify the account builder.

pub fn inflight_transfers(&self) -> Result<Arc<InflightTransfers>, Error>

Available on crate feature files only.

Inflight file transfers.

impl NetworkAccount

pub async fn server_status( &self, options: &SyncOptions, ) -> HashMap<Origin, Result<SyncStatus, Error>>

Sync status for remote servers.

pub async fn transfer_status( &self, options: &SyncOptions, ) -> Result<HashMap<Origin, Result<FileTransfersSet, Error>>, Error>

Available on crate feature files only.

Transfer status for remote servers.

Trait Implementations

impl Account for NetworkAccount

type Error = Error

Errors for this account.

type NetworkResult = SyncResult<<NetworkAccount as Account>::Error>

Result type for network-aware implementations.

fn account_id(&self) -> &AccountId

Account identifier.

fn paths(&self) -> Arc<Paths>

User storage paths.

fn backend_target<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = BackendTarget> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Account backend target.

fn folder<'life0, 'life1, 'async_trait>( &'life0 self, folder_id: &'life1 VaultId, ) -> Pin<Box<dyn Future<Output = Result<Folder, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Lookup a folder in the storage.

fn is_authenticated<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Determine if the account is authenticated.

fn import_account_events<'life0, 'async_trait>( &'life0 mut self, events: CreateSet, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Import encrypted account events into the client storage.

fn new_device_vault<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(DeviceSigner, DeviceManager), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create a new in-memory device vault.

fn device_signer<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<DeviceSigner, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Signing key for the device.

fn device_public_key<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<DevicePublicKey, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Public key for the device signing key.

fn patch_devices_unchecked<'life0, 'life1, 'async_trait>( &'life0 mut self, events: &'life1 [DeviceEvent], ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Patch the devices event log.

fn revoke_device<'life0, 'life1, 'async_trait>( &'life0 mut self, device_key: &'life1 DevicePublicKey, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Revoke a device.

fn current_device<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<TrustedDevice, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Current device information.

fn trusted_devices<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<IndexSet<TrustedDevice>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Collection of trusted devices.

fn public_identity<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<PublicIdentity, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Public identity information.

fn account_name<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Name of this account.

fn folder_description<'life0, 'life1, 'async_trait>( &'life0 mut self, folder_id: &'life1 VaultId, ) -> Pin<Box<dyn Future<Output = Result<String, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get the description of a folder.

fn set_folder_description<'life0, 'life1, 'async_trait>( &'life0 mut self, folder_id: &'life1 VaultId, description: impl 'async_trait + AsRef<str> + Send + Sync, ) -> Pin<Box<dyn Future<Output = Result<FolderChange<Self::NetworkResult>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Set the description of a folder.

fn login_folder_summary<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Summary, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Summary of the identity folder for the account.

fn reload_login_folder<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Reload the identity folder into memory.

fn change_cipher<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, account_key: &'life1 AccessKey, cipher: &'life2 Cipher, kdf: Option<KeyDerivation>, ) -> Pin<Box<dyn Future<Output = Result<CipherComparison, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Change the cipher for an account.

fn change_account_password<'life0, 'async_trait>( &'life0 mut self, password: SecretString, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Change the password for an account.

fn sign_in<'life0, 'life1, 'async_trait>( &'life0 mut self, key: &'life1 AccessKey, ) -> Pin<Box<dyn Future<Output = Result<Vec<Summary>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Access an account by signing in.

fn verify<'life0, 'life1, 'async_trait>( &'life0 self, key: &'life1 AccessKey, ) -> Pin<Box<dyn Future<Output = bool> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Verify an access key for this account.

fn open_folder<'life0, 'life1, 'async_trait>( &'life0 self, folder_id: &'life1 VaultId, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Open a folder.

fn current_folder<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Option<Summary>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Current open folder.

fn history<'life0, 'life1, 'async_trait>( &'life0 self, folder_id: &'life1 VaultId, ) -> Pin<Box<dyn Future<Output = Result<Vec<(CommitHash, UtcDateTime, WriteEvent)>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

History of events for a folder.

fn sign_out<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sign out of the account.

fn rename_account<'life0, 'async_trait>( &'life0 mut self, account_name: String, ) -> Pin<Box<dyn Future<Output = Result<AccountChange<Self::NetworkResult>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Rename this account.

fn delete_account<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Delete the account for this user and sign out.

fn find<'life0, 'async_trait, P>( &'life0 self, predicate: P, ) -> Pin<Box<dyn Future<Output = Option<Summary>> + Send + 'async_trait>>

where P: FnMut(&&Summary) -> bool + Send + 'async_trait, Self: 'async_trait, 'life0: 'async_trait,

Try to find a folder using a predicate.

fn find_folder<'life0, 'life1, 'async_trait>( &'life0 self, vault: &'life1 FolderRef, ) -> Pin<Box<dyn Future<Output = Option<Summary>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Try to find a folder by reference.

fn load_folders<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<Vec<Summary>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Load folders into memory.

fn list_folders<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Vec<Summary>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

List in-memory folders managed by this account.

fn list_secret_ids<'life0, 'life1, 'async_trait>( &'life0 self, folder_id: &'life1 VaultId, ) -> Pin<Box<dyn Future<Output = Result<Vec<SecretId>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Read the secret identifiers in a folder.

fn account_data<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<AccountData, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Account data.

fn root_hash<'life0, 'life1, 'async_trait>( &'life0 self, folder_id: &'life1 VaultId, ) -> Pin<Box<dyn Future<Output = Result<CommitHash, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Root hash of the event log for a folder.

fn identity_state<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<CommitState, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Commit state of the identity vault.

fn commit_state<'life0, 'life1, 'async_trait>( &'life0 self, folder_id: &'life1 VaultId, ) -> Pin<Box<dyn Future<Output = Result<CommitState, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Get the commit state for a folder.

fn compact_account<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<HashMap<Summary, AccountEvent>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Compact the identity folder and all user folders.

fn compact_folder<'life0, 'life1, 'async_trait>( &'life0 mut self, folder_id: &'life1 VaultId, ) -> Pin<Box<dyn Future<Output = Result<AccountEvent, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Compact the event log file for a folder.

fn restore_folder<'life0, 'life1, 'async_trait>( &'life0 mut self, folder_id: &'life1 VaultId, records: Vec<EventRecord>, ) -> Pin<Box<dyn Future<Output = Result<Summary, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Restore a folder from an event log.

fn change_folder_password<'life0, 'life1, 'async_trait>( &'life0 mut self, folder_id: &'life1 VaultId, new_key: AccessKey, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Change the password for a folder.

fn detached_view<'life0, 'life1, 'async_trait>( &'life0 self, folder_id: &'life1 VaultId, commit: CommitHash, ) -> Pin<Box<dyn Future<Output = Result<DetachedView, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Create a detached view of an event log until a particular commit.

fn initialize_search_index<'life0, 'async_trait>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<(DocumentCount, Vec<Summary>), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Initialize the search index.

fn statistics<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = AccountStatistics> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Compute the account statistics.

fn search_index<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Arc<RwLock<SearchIndex>>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Search index for the account.

fn query_view<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, views: &'life1 [DocumentView], archive: Option<&'life2 ArchiveFilter>, ) -> Pin<Box<dyn Future<Output = Result<Vec<Document>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Query with document views.

fn query_map<'life0, 'life1, 'async_trait>( &'life0 self, query: &'life1 str, filter: QueryFilter, ) -> Pin<Box<dyn Future<Output = Result<Vec<Document>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Query the search index.

fn document_count<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<DocumentCount, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Get the search index document count statistics.

fn document_exists<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, vault_id: &'life1 VaultId, label: &'life2 str, id: Option<&'life3 SecretId>, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Determine if a document exists in a folder.

fn download_file<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, vault_id: &'life1 VaultId, secret_id: &'life2 SecretId, file_name: &'life3 ExternalFileName, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Decrypt a file and return the buffer.

fn create_secret<'life0, 'async_trait>( &'life0 mut self, meta: SecretMeta, secret: Secret, options: AccessOptions, ) -> Pin<Box<dyn Future<Output = Result<SecretChange<Self::NetworkResult>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create a secret in the current open folder or a specific folder.

fn insert_secrets<'life0, 'async_trait>( &'life0 mut self, secrets: Vec<(SecretMeta, Secret)>, ) -> Pin<Box<dyn Future<Output = Result<SecretInsert<Self::NetworkResult>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Bulk insert secrets into the currently open folder.

fn update_secret<'life0, 'life1, 'async_trait>( &'life0 mut self, secret_id: &'life1 SecretId, meta: SecretMeta, secret: Option<Secret>, options: AccessOptions, ) -> Pin<Box<dyn Future<Output = Result<SecretChange<Self::NetworkResult>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Update a secret in the current open folder or a specific folder.

fn move_secret<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 mut self, secret_id: &'life1 SecretId, from: &'life2 VaultId, to: &'life3 VaultId, options: AccessOptions, ) -> Pin<Box<dyn Future<Output = Result<SecretMove<Self::NetworkResult>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Move a secret between folders.

fn read_secret<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, secret_id: &'life1 SecretId, folder: Option<&'life2 VaultId>, ) -> Pin<Box<dyn Future<Output = Result<(SecretRow, ReadEvent), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Read a secret in the current open folder.

fn raw_secret<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, folder_id: &'life1 VaultId, secret_id: &'life2 SecretId, ) -> Pin<Box<dyn Future<Output = Result<Option<(VaultCommit, ReadEvent)>, Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Read the encrypted contents of a secret.

fn delete_secret<'life0, 'life1, 'async_trait>( &'life0 mut self, secret_id: &'life1 SecretId, options: AccessOptions, ) -> Pin<Box<dyn Future<Output = Result<SecretDelete<Self::NetworkResult>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete a secret and remove any external files.

fn archive<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, folder_id: &'life1 VaultId, secret_id: &'life2 SecretId, options: AccessOptions, ) -> Pin<Box<dyn Future<Output = Result<SecretMove<Self::NetworkResult>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Move a secret to the archive.

fn unarchive<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, secret_id: &'life1 SecretId, secret_kind: &'life2 SecretType, options: AccessOptions, ) -> Pin<Box<dyn Future<Output = Result<(SecretMove<Self::NetworkResult>, Summary), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Move a secret out of the archive.

fn update_file<'life0, 'life1, 'async_trait>( &'life0 mut self, secret_id: &'life1 SecretId, meta: SecretMeta, path: impl 'async_trait + AsRef<Path> + Send + Sync, options: AccessOptions, ) -> Pin<Box<dyn Future<Output = Result<SecretChange<Self::NetworkResult>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Update a file secret.

fn create_folder<'life0, 'async_trait>( &'life0 mut self, options: NewFolderOptions, ) -> Pin<Box<dyn Future<Output = Result<FolderCreate<Self::NetworkResult>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create a folder.

fn rename_folder<'life0, 'life1, 'async_trait>( &'life0 mut self, folder_id: &'life1 VaultId, name: String, ) -> Pin<Box<dyn Future<Output = Result<FolderChange<Self::NetworkResult>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Rename a folder.

fn update_folder_flags<'life0, 'life1, 'async_trait>( &'life0 mut self, folder_id: &'life1 VaultId, flags: VaultFlags, ) -> Pin<Box<dyn Future<Output = Result<FolderChange<Self::NetworkResult>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Update folder flags.

fn import_folder<'life0, 'async_trait>( &'life0 mut self, path: impl 'async_trait + AsRef<Path> + Send + Sync, key: AccessKey, overwrite: bool, ) -> Pin<Box<dyn Future<Output = Result<FolderCreate<Self::NetworkResult>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Import a folder from a vault file.

fn import_login_folder<'life0, 'async_trait>( &'life0 mut self, vault: Vault, ) -> Pin<Box<dyn Future<Output = Result<AccountEvent, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Import and overwrite the identity folder from a vault.

fn import_folder_buffer<'life0, 'async_trait>( &'life0 mut self, buffer: impl 'async_trait + AsRef<[u8]> + Send + Sync, key: AccessKey, overwrite: bool, ) -> Pin<Box<dyn Future<Output = Result<FolderCreate<Self::NetworkResult>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Import a folder from a vault buffer.

fn export_folder<'life0, 'life1, 'async_trait>( &'life0 mut self, path: impl 'async_trait + AsRef<Path> + Send + Sync, folder_id: &'life1 VaultId, new_key: AccessKey, save_key: bool, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Export a folder as a vault file.

fn export_folder_buffer<'life0, 'life1, 'async_trait>( &'life0 mut self, folder_id: &'life1 VaultId, new_key: AccessKey, save_key: bool, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Export a folder to a buffer.

fn delete_folder<'life0, 'life1, 'async_trait>( &'life0 mut self, folder_id: &'life1 VaultId, ) -> Pin<Box<dyn Future<Output = Result<FolderDelete<Self::NetworkResult>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Delete a folder.

fn forget_folder<'life0, 'life1, 'async_trait>( &'life0 mut self, folder_id: &'life1 VaultId, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Forget a folder from in-memory collections.

fn load_avatar<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, secret_id: &'life1 SecretId, folder: Option<&'life2 VaultId>, ) -> Pin<Box<dyn Future<Output = Result<Option<Vec<u8>>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Try to load an avatar JPEG image for a contact.

fn export_contact<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, path: impl 'async_trait + AsRef<Path> + Send + Sync, secret_id: &'life1 SecretId, folder: Option<&'life2 VaultId>, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Export a contact secret to a vCard file.

fn export_all_contacts<'life0, 'async_trait>( &'life0 self, path: impl 'async_trait + AsRef<Path> + Send + Sync, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Export all contacts to a single vCard.

fn import_contacts<'life0, 'life1, 'async_trait>( &'life0 mut self, content: &'life1 str, progress: impl 'async_trait + Fn(ContactImportProgress) + Send + Sync, ) -> Pin<Box<dyn Future<Output = Result<Vec<SecretId>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Import contacts from a vCard string buffer.

fn export_unsafe_archive<'life0, 'async_trait>( &'life0 self, path: impl 'async_trait + AsRef<Path> + Send + Sync, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Write a zip archive containing all the secrets for the account unencrypted.

fn import_file<'life0, 'async_trait>( &'life0 mut self, target: ImportTarget, ) -> Pin<Box<dyn Future<Output = Result<FolderCreate<Self::NetworkResult>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Import secrets from another app.

fn export_backup_archive<'life0, 'async_trait>( &'life0 self, path: impl 'async_trait + AsRef<Path> + Send + Sync, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Create a backup archive containing the encrypted data for the account.

fn import_backup_archive<'life0, 'async_trait>( path: impl 'async_trait + AsRef<Path> + Send + Sync, target: &'life0 BackendTarget, ) -> Pin<Box<dyn Future<Output = Result<Vec<PublicIdentity>, Error>> + Send + 'async_trait>>

where 'life0: 'async_trait,

Restore from a backup archive file.

fn copy_clipboard<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, clipboard: &'life1 Clipboard, target: &'life2 SecretPath, request: &'life3 ClipboardCopyRequest, ) -> Pin<Box<dyn Future<Output = Result<bool, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Copy a secret to the clipboard.

fn default_folder<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Option<Summary>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Find the default folder.

fn authenticator_folder<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Option<Summary>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Find the authenticator folder.

fn contacts_folder<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Option<Summary>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Find the contacts folder.

fn archive_folder<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Option<Summary>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Find the archive folder.

impl AccountSync for NetworkAccount

type Error = Error

Error type for account sync.

fn sync<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = SyncResult<Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Perform a full sync of the account using the default options.

fn sync_with_options<'life0, 'life1, 'async_trait>( &'life0 self, options: &'life1 SyncOptions, ) -> Pin<Box<dyn Future<Output = SyncResult<Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Perform a full sync of the account using the given options.

fn sync_file_transfers<'life0, 'life1, 'async_trait>( &'life0 self, options: &'life1 SyncOptions, ) -> Pin<Box<dyn Future<Output = SyncResult<Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Sync file transfers.

fn force_update<'life0, 'life1, 'async_trait>( &'life0 self, account_data: UpdateSet, options: &'life1 SyncOptions, ) -> Pin<Box<dyn Future<Output = SyncResult<Self::Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Force update an account on remote servers.

impl DelegatedAccess for NetworkAccount

type Error = Error

Error type.

fn find_folder_password<'life0, 'life1, 'async_trait>( &'life0 self, folder_id: &'life1 VaultId, ) -> Pin<Box<dyn Future<Output = Result<Option<AccessKey>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Find a folder password.

fn remove_folder_password<'life0, 'life1, 'async_trait>( &'life0 mut self, folder_id: &'life1 VaultId, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Remove a folder password.

fn save_folder_password<'life0, 'life1, 'async_trait>( &'life0 mut self, folder_id: &'life1 VaultId, key: AccessKey, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Save a folder password.

fn generate_folder_password(&self) -> Result<SecretBox<str>, Self::Error>

Generate a folder password.

impl ForceMerge for NetworkAccount

fn force_merge_files<'life0, 'life1, 'async_trait>( &'life0 mut self, diff: FileDiff, outcome: &'life1 mut MergeOutcome, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Force merge changes to the files event log.

fn force_merge_identity<'life0, 'life1, 'async_trait>( &'life0 mut self, diff: FolderDiff, outcome: &'life1 mut MergeOutcome, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Force merge changes to the identity folder.

fn force_merge_account<'life0, 'life1, 'async_trait>( &'life0 mut self, diff: AccountDiff, outcome: &'life1 mut MergeOutcome, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Force merge changes to the account event log.

fn force_merge_device<'life0, 'life1, 'async_trait>( &'life0 mut self, diff: DeviceDiff, outcome: &'life1 mut MergeOutcome, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Force merge changes to the devices event log.

fn force_merge_folder<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, folder_id: &'life1 VaultId, diff: FolderDiff, outcome: &'life2 mut MergeOutcome, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Force merge changes to a folder.

fn force_merge_update<'life0, 'life1, 'async_trait>( &'life0 mut self, update_set: UpdateSet, outcome: &'life1 mut MergeOutcome, ) -> Pin<Box<dyn Future<Output = Result<(), Self::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: Send + 'async_trait,

Force merge from a set of updates.

impl From<&NetworkAccount> for AccountRef

fn from(value: &NetworkAccount) -> Self

Converts to this type from the input type.

impl Merge for NetworkAccount

fn merge_identity<'life0, 'life1, 'async_trait>( &'life0 mut self, diff: FolderDiff, outcome: &'life1 mut MergeOutcome, ) -> Pin<Box<dyn Future<Output = Result<CheckedPatch, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Merge changes to the identity folder.

fn compare_identity<'life0, 'life1, 'async_trait>( &'life0 self, state: &'life1 CommitState, ) -> Pin<Box<dyn Future<Output = Result<Comparison, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Compare the identity folder.

fn merge_account<'life0, 'life1, 'async_trait>( &'life0 mut self, diff: AccountDiff, outcome: &'life1 mut MergeOutcome, ) -> Pin<Box<dyn Future<Output = Result<(CheckedPatch, HashSet<VaultId>), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Merge changes to the account event log.

fn compare_account<'life0, 'life1, 'async_trait>( &'life0 self, state: &'life1 CommitState, ) -> Pin<Box<dyn Future<Output = Result<Comparison, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Compare the account events.

fn merge_device<'life0, 'life1, 'async_trait>( &'life0 mut self, diff: DeviceDiff, outcome: &'life1 mut MergeOutcome, ) -> Pin<Box<dyn Future<Output = Result<CheckedPatch, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Merge changes to the devices event log.

fn compare_device<'life0, 'life1, 'async_trait>( &'life0 self, state: &'life1 CommitState, ) -> Pin<Box<dyn Future<Output = Result<Comparison, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Compare the device events.

fn merge_files<'life0, 'life1, 'async_trait>( &'life0 mut self, diff: FileDiff, outcome: &'life1 mut MergeOutcome, ) -> Pin<Box<dyn Future<Output = Result<CheckedPatch, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Merge changes to the files event log.

fn compare_files<'life0, 'life1, 'async_trait>( &'life0 self, state: &'life1 CommitState, ) -> Pin<Box<dyn Future<Output = Result<Comparison, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Compare the file events.

fn merge_folder<'life0, 'life1, 'life2, 'async_trait>( &'life0 mut self, folder_id: &'life1 VaultId, diff: FolderDiff, outcome: &'life2 mut MergeOutcome, ) -> Pin<Box<dyn Future<Output = Result<(CheckedPatch, Vec<WriteEvent>), Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Merge changes to a folder.

fn compare_folder<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, folder_id: &'life1 VaultId, state: &'life2 CommitState, ) -> Pin<Box<dyn Future<Output = Result<Comparison, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Compare folder events.

fn compare<'life0, 'life1, 'async_trait>( &'life0 mut self, remote_status: &'life1 SyncStatus, ) -> Pin<Box<dyn Future<Output = Result<SyncCompare, Self::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: Send + 'async_trait,

Compare the local state to a remote status.

fn merge<'life0, 'life1, 'async_trait>( &'life0 mut self, diff: SyncDiff, outcome: &'life1 mut MergeOutcome, ) -> Pin<Box<dyn Future<Output = Result<SyncCompare, Self::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: Send + 'async_trait,

Merge a diff into this storage.

impl StorageEventLogs for NetworkAccount

type Error = Error

Error type for storage event logs.

fn identity_log<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Arc<RwLock<FolderEventLog>>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Clone of the identity log.

fn account_log<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Arc<RwLock<AccountEventLog>>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Clone of the account log.

fn device_log<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Arc<RwLock<DeviceEventLog>>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Clone of the device log.

fn file_log<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Arc<RwLock<FileEventLog>>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Clone of the file log.

fn folder_details<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<IndexSet<Summary>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Folders managed by this storage.

fn folder_log<'life0, 'life1, 'async_trait>( &'life0 self, id: &'life1 VaultId, ) -> Pin<Box<dyn Future<Output = Result<Arc<RwLock<FolderEventLog>>, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Folder event log.

fn canonical_files<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<IndexSet<ExternalFile>, Self::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: 'async_trait,

Canonical collection of files reduced from the file event log.

impl SyncStorage for NetworkAccount

fn is_client_storage(&self) -> bool

Determine if this is client-side storage.

fn sync_status<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<SyncStatus, Error>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Sync status for the storage.

fn create_set<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<CreateSet, Self::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Set of all event logs.

fn debug_account_tree<'life0, 'async_trait>( &'life0 self, account_id: AccountId, ) -> Pin<Box<dyn Future<Output = Result<DebugTree, Self::Error>> + Send + 'async_trait>>

where 'life0: 'async_trait, Self: Sync + 'async_trait,

Create a debug tree of this account.