Struct Paths

pub struct Paths { /* private fields */ }

File system paths.

Clients and servers may be configured to run on the same machine and point to the same data directory so different prefixes are used to distinguish.

Clients write to a local directory whilst servers write to a remote directory.

Several functions require a user identifier and will panic if a user identifier has not been set, see the function documentation for details.

Implementations

impl Paths

pub fn new(documents_dir: impl AsRef<Path>, user_id: impl AsRef<str>) -> Self

Create new paths for a client.

pub fn new_server( documents_dir: impl AsRef<Path>, user_id: impl AsRef<str>, ) -> Self

Create new paths for a server.

pub fn new_global(documents_dir: impl AsRef<Path>) -> Self

Create new paths for a client with an empty user identifier.

Used to get application level paths when a user identifier is not available.

pub fn new_global_server(documents_dir: impl AsRef<Path>) -> Self

Create new paths for a client with an empty user identifier.

Used to get application level paths when a user identifier is not available.

pub fn is_server(&self) -> bool

Whether these paths are for server-side storage.

pub fn with_account_id(&self, account_id: &AccountId) -> Self

Clone of paths with an account identifier.

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

Ensure the local storage directory exists.

If a user identifier is available this will also create some user-specific directories.

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

Ensure the local storage directory exists for version 2 database storage.

pub fn is_using_db(&self) -> bool

Determine if a database file exists.

pub async fn is_usable(&self) -> Result<bool, Error>

Try to determine if the account is ready to be used by checking for the presence of required files on disc.

pub fn database_file(&self) -> &PathBuf

Path to the database file for an account.

Panics

If the paths are global.

pub fn blobs_dir(&self) -> &PathBuf

External file blobs directory.

pub fn blobs_account_dir(&self) -> PathBuf

Expected location for the directory containing all the external file blobs for an account.

Panics

If this set of paths are global (no user identifier).

pub fn blob_folder_location(&self, vault_id: &VaultId) -> PathBuf

Expected location for the directory containing all the external files for a folder.

Panics

If this set of paths are global (no user identifier).

pub fn blob_location( &self, vault_id: &VaultId, secret_id: &SecretId, file_name: impl AsRef<str>, ) -> PathBuf

Expected location for an external file blob.

Panics

If this set of paths are global (no user identifier).

pub fn user_id(&self) -> &str

User identifier.

pub fn documents_dir(&self) -> &PathBuf

Top-level storage directory.

pub fn is_global(&self) -> bool

Determine if the paths are global.

Paths are global when a user identifier is not available.

pub fn identity_dir(&self) -> &PathBuf

Path to the identity vault directory.

pub fn local_dir(&self) -> &PathBuf

Path to the local storage.

pub fn logs_dir(&self) -> &PathBuf

Path to the logs directory.

pub fn audit_file(&self) -> &PathBuf

Path to the audit file.

pub fn preferences_file(&self) -> PathBuf

Path to the file used to store global or account-level preferences.

pub fn system_messages_file(&self) -> PathBuf

Path to the file used to store account-level system messages.

Panics

If this set of paths are global (no user identifier).

pub fn user_dir(&self) -> &PathBuf

User specific storage directory.

Panics

If this set of paths are global (no user identifier).

pub fn files_dir(&self) -> &PathBuf

User’s files directory.

Panics

If this set of paths are global (no user identifier).

pub fn file_folder_location(&self, vault_id: &VaultId) -> PathBuf

Expected location for the directory containing all the external files for a folder.

Panics

If this set of paths are global (no user identifier).

pub fn file_location( &self, vault_id: &VaultId, secret_id: &SecretId, file_name: impl AsRef<str>, ) -> PathBuf

Expected location for a file.

Panics

If this set of paths are global (no user identifier).

pub fn vaults_dir(&self) -> &PathBuf

User’s vaults storage directory.

Panics

If this set of paths are global (no user identifier).

pub fn device_file(&self) -> &PathBuf

User’s device signing key vault file.

Panics

If this set of paths are global (no user identifier).

pub fn identity_vault(&self) -> PathBuf

Path to the identity vault file for this user.

Panics

If this set of paths are global (no user identifier).

pub fn identity_events(&self) -> PathBuf

Path to the identity events log for this user.

Panics

If this set of paths are global (no user identifier).

pub fn vault_path(&self, id: &VaultId) -> PathBuf

Path to a vault file from it’s identifier.

Panics

If this set of paths are global (no user identifier).

pub fn event_log_path(&self, id: &VaultId) -> PathBuf

Path to an event log file from it’s identifier.

Panics

If this set of paths are global (no user identifier).

pub fn account_events(&self) -> PathBuf

Path to the user’s account event log file.

Panics

If this set of paths are global (no user identifier).

pub fn device_events(&self) -> PathBuf

Path to the user’s event log of device changes.

Panics

If this set of paths are global (no user identifier).

pub fn file_events(&self) -> PathBuf

Path to the user’s event log of external file changes.

Panics

If this set of paths are global (no user identifier).

pub fn remote_origins(&self) -> PathBuf

Path to the file used to store remote origins.

Panics

If this set of paths are global (no user identifier).

pub async fn scaffold(data_dir: Option<PathBuf>) -> Result<(), Error>

Ensure the root directories exist for file system storage.

pub async fn scaffold_db(data_dir: Option<PathBuf>) -> Result<(), Error>

Ensure the root directories exist for database storage.

pub fn set_data_dir(path: PathBuf)

Set an explicit data directory used to store all application files.

pub fn clear_data_dir()

Clear an explicitly set data directory.

pub fn data_dir() -> Result<PathBuf, Error>

Get the default root directory used for caching application data.

If the SOS_DATA_DIR environment variable is set it is used.

Otherwise if an explicit directory has been set using set_data_dir() then that will be used instead.

Finally if no environment variable or explicit directory has been set then a path will be computed by platform convention.

When running with debug_assertions a debug path is appended (except when executing tests) so that we can use different storage locations for debug and release builds.

If the SOS_TEST environment variable is set then we use test rather than debug as the nested directory so that test data does not collide with debug data.

Trait Implementations

impl Clone for Paths

fn clone(&self) -> Paths

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Paths

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Paths

fn default() -> Paths

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Paths

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Paths

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.