Struct PersistentRoot

pub struct PersistentRoot { /* private fields */ }

A persistent working directory where Ditto will store its data across restarts of the host process on the local file system

Implementations

impl PersistentRoot

pub fn new(root_dir: impl Into<PathBuf>) -> Result<Self, DittoError>

Manually construct a root directory

pub fn from_current_exe() -> Result<Self, DittoError>

Get a Ditto directory from the path of the current executable

pub fn from_env() -> Result<Self, DittoError>

Create a Ditto directory from env vars

Trait Implementations

impl Default for PersistentRoot

fn default() -> Self

Returns the “default value” for a type.

impl DittoRoot for PersistentRoot

fn root_path(&self) -> &Path

Return the root path of the Ditto directory

fn exists(&self) -> bool

Return true if the Root path exists

fn is_valid(&self) -> Result<(), DittoError>

Return true if the provided Root path is a valid path

fn data_path(&self) -> &Path

👎Deprecated: Use root_path instead

Return the path of the data in the Ditto directory

fn root_dir_to_c_str(&self) -> Result<Box, DittoError>

Emits the Ditto root directory path as a null-terminated UTF-8 C-string

fn data_dir_to_c_str(&self) -> Result<Box, DittoError>

👎Deprecated: Use root_dir_to_c_str instead

Emits the Ditto data directory path as a null-terminated UTF-8 C-string

fn root_path_as_str(&self) -> Result<&str, DittoError>

Return the Root path as a &str

fn data_path_as_str(&self) -> Result<&str, DittoError>

👎Deprecated: Use root_path_as_str instead

Returns the path of the Ditto data directory as an &str