Struct Repository

pub struct Repository { /* private fields */ }

Implementations

impl Repository

pub async fn create( params: &RepositoryParams<impl Recorder>, access: Access, ) -> Result<Self>

Creates a new repository.

pub async fn open( params: &RepositoryParams<impl Recorder>, local_secret: Option<LocalSecret>, access_mode: AccessMode, ) -> Result<Self>

Opens an existing repository.

pub async fn database_id(&self) -> Result<DatabaseId>

pub async fn requires_local_secret_for_reading(&self) -> Result<bool>

pub async fn requires_local_secret_for_writing(&self) -> Result<bool>

pub async fn set_access( &self, read_change: Option<AccessChange>, write_change: Option<AccessChange>, ) -> Result<()>

Sets, unsets or changes local secrets for accessing the repository or disables the given access mode.

In order to enable or change a given access mode the repository must currently be in at least that access mode. Disabling an access mode doesn’t have this restriction.

Disabling a given access mode makes the repo impossible to be opened in that mode anymore. However, when the repo is currently in that mode it still remains in it until the repo is closed.

To restore a disabled mode the repo must first be put into that mode using Self::set_credentials() where the Credentials must be obtained from AccessSecrets with at least the mode one wants to restore.

If read or write is None then no change is made to that mode. If both are None then this function is a no-op.

Disabling the read mode while keeping write mode enabled is allowed but not very useful as write mode also grants read access.

pub fn credentials(&self) -> Credentials

Gets the current credentials of this repository.

See also Self::set_credentials().

pub fn secrets(&self) -> AccessSecrets

pub fn access_mode(&self) -> AccessMode

Gets the current access mode of this repository.

pub async fn set_access_mode( &self, access_mode: AccessMode, local_secret: Option<LocalSecret>, ) -> Result<()>

Switches the repository to the given mode.

The actual mode the repository gets switched to is the higher of the current access mode and the mode provided by local_key but at most the mode specified in access_mode (“higher” means according to AccessMode’s Ord impl, that is: Write > Read > Blind).

pub async fn set_credentials(&self, credentials: Credentials) -> Result<()>

Overrides the current credentials of this repository.

This is useful for moving/renaming the repo database or to restore access which has been either disabled or it’s local secret lost.

Move/rename the repo db

1. Obtain the current credentials with Self::credentials() and keep them locally.
2. Close the repo.
3. Rename the repo database files(s).
4. Open the repo from its new location in blind mode.
5. Restore the credentials from step 1 with Self::set_credentials().

Restore access

1. Get the AccessSecrets the repository was originally created from (e.g., by extracting them from the original ShareToken).
2. Construct Credentials using this access secrets and a random writer id.
3. Restore the credentials with Self::set_credentials().
4. Enable/change the access with Self::set_access().

pub async fn unlock_secrets( &self, local_secret: LocalSecret, ) -> Result<AccessSecrets>

pub fn metadata(&self) -> Metadata

Get accessor for repository metadata. The metadata are arbitrary key-value entries that are stored inside the repository but not synced to other replicas.

pub async fn set_quota(&self, quota: Option<StorageSize>) -> Result<()>

Set the storage quota in bytes. Use None to disable quota. Default is None.

pub async fn quota(&self) -> Result<Option<StorageSize>>

Get the storage quota in bytes or None if no quota is set.

pub async fn set_block_expiration( &self, block_expiration: Option<Duration>, ) -> Result<()>

Set the duration after which blocks start to expire (are deleted) when not used. Use None to disable expiration. Default is None.

pub fn block_expiration(&self) -> Option<Duration>

Get the block expiration duration. None means block expiration is not set.

pub fn last_block_expiration_time(&self) -> Option<SystemTime>

Get the time when the last block expired or None if there are still some unexpired blocks. If block expiration is not enabled, always return None.

pub async fn size(&self) -> Result<StorageSize>

Get the total size of the data stored in this repository.

pub fn handle(&self) -> RepositoryHandle

pub async fn get_read_password_salt(&self) -> Result<PasswordSalt>

pub async fn get_write_password_salt(&self) -> Result<PasswordSalt>

pub fn monitor(&self) -> &StateMonitor

Get the state monitor node of this repository.

pub async fn export(&self, dst: &Path) -> Result<()>

Export the repository to the given file.

The repository is currently exported as read-only with no password. In the future other modes might be added.

pub async fn lookup_type<P: AsRef<Utf8Path>>( &self, path: P, ) -> Result<EntryType>

Looks up an entry by its path. The path must be relative to the repository root. If the entry exists, returns its JointEntryType, otherwise returns EntryNotFound.

pub async fn open_file<P: AsRef<Utf8Path>>(&self, path: P) -> Result<File>

Opens a file at the given path (relative to the repository root)

pub async fn open_file_version<P: AsRef<Utf8Path>>( &self, path: P, branch_id: &PublicKey, ) -> Result<File>

Open a specific version of the file at the given path.

pub async fn open_directory<P: AsRef<Utf8Path>>( &self, path: P, ) -> Result<JointDirectory>

Opens a directory at the given path (relative to the repository root)

pub async fn create_file<P: AsRef<Utf8Path>>(&self, path: P) -> Result<File>

Creates a new file at the given path.

pub async fn create_directory<P: AsRef<Utf8Path>>( &self, path: P, ) -> Result<Directory>

Creates a new directory at the given path.

pub async fn remove_entry<P: AsRef<Utf8Path>>(&self, path: P) -> Result<()>

Removes the file or directory (must be empty) and flushes its parent directory.

pub async fn remove_entry_recursively<P: AsRef<Utf8Path>>( &self, path: P, ) -> Result<()>

Removes the file or directory (including its content) and flushes its parent directory.

pub async fn move_entry<S: AsRef<Utf8Path>, D: AsRef<Utf8Path>>( &self, src_dir_path: S, src_name: &str, dst_dir_path: D, dst_name: &str, ) -> Result<()>

Moves (renames) an entry from the source path to the destination path. If both source and destination refer to the same entry, this is a no-op.

pub fn local_branch(&self) -> Result<Branch>

Returns the local branch or Error::PermissionDenied if this repo doesn’t have at least read access.

pub async fn load_branches(&self) -> Result<Vec<Branch>>

pub async fn get_branch_version_vector( &self, writer_id: &PublicKey, ) -> Result<VersionVector>

Returns version vector of the given branch. Works in all access moded.

pub async fn get_merged_version_vector(&self) -> Result<VersionVector>

Returns the version vector calculated by merging the version vectors of all branches.

pub fn subscribe(&self) -> Receiver<Event>

Subscribe to event notifications.

pub async fn sync_progress(&self) -> Result<Progress>

Gets the syncing progress of this repository (number of downloaded blocks / number of all blocks)

pub async fn check_integrity(&self) -> Result<bool>

Check integrity of the stored data.

pub async fn cd<P: AsRef<Utf8Path>>(&self, path: P) -> Result<JointDirectory>

pub async fn close(&self) -> Result<()>

Close all db connections held by this repository. After this function returns, any subsequent operation on this repository that requires to access the db returns an error.

pub async fn debug_print_root(&self)

pub async fn debug_print(&self, print: DebugPrinter)

pub async fn count_blocks(&self) -> Result<u64>

Returns the total number of blocks in this repository. This is useful for diagnostics and tests.