Struct dittolive_ditto::fs::PersistentRoot
source · [−]pub struct PersistentRoot { /* private fields */ }
Expand description
A persistent working directory where Ditto will store its data across restarts of the host process on the local file system
Implementations
sourceimpl PersistentRoot
impl PersistentRoot
sourcepub fn new(root_dir: impl Into<PathBuf>) -> Result<Self, DittoError>
pub fn new(root_dir: impl Into<PathBuf>) -> Result<Self, DittoError>
Manually construct a root directory
sourcepub fn from_current_exe() -> Result<Self, DittoError>
pub fn from_current_exe() -> Result<Self, DittoError>
Get a Ditto directory from the path of the current executable
sourcepub fn from_env() -> Result<Self, DittoError>
pub fn from_env() -> Result<Self, DittoError>
Create a Ditto directory from env vars
Trait Implementations
sourceimpl Default for PersistentRoot
impl Default for PersistentRoot
sourceimpl DittoRoot for PersistentRoot
impl DittoRoot for PersistentRoot
sourcefn is_valid(&self) -> Result<(), DittoError>
fn is_valid(&self) -> Result<(), DittoError>
Return true if the provided Root path is a valid path
sourcefn data_path(&self) -> &Path
fn data_path(&self) -> &Path
👎Deprecated: Use root_path instead
Return the path of the data in the Ditto directory
sourcefn root_dir_to_c_str(&self) -> Result<Box, DittoError>
fn root_dir_to_c_str(&self) -> Result<Box, DittoError>
Emits the Ditto root directory path as a null-terminated UTF-8 C-string
sourcefn data_dir_to_c_str(&self) -> Result<Box, DittoError>
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
sourcefn root_path_as_str(&self) -> Result<&str, DittoError>
fn root_path_as_str(&self) -> Result<&str, DittoError>
Return the Root path as a
&str
sourcefn data_path_as_str(&self) -> Result<&str, DittoError>
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
Auto Trait Implementations
impl RefUnwindSafe for PersistentRoot
impl Send for PersistentRoot
impl Sync for PersistentRoot
impl Unpin for PersistentRoot
impl UnwindSafe for PersistentRoot
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
impl<T> CompatExt for T
impl<T> CompatExt for T
fn compat_ref(&self) -> Compat<&T>
fn compat_ref(&self) -> Compat<&T>
Applies the [
Compat
] adapter by shared reference. Read morefn compat_mut(&mut self) -> Compat<&mut T>
fn compat_mut(&mut self) -> Compat<&mut T>
Applies the [
Compat
] adapter by mutable reference. Read more