Skip to main content

Paths

Struct Paths 

Source
pub struct Paths {
    pub data_dir: PathBuf,
    pub config_dir: PathBuf,
    pub config_file: PathBuf,
    pub state_dir: PathBuf,
}
Expand description

XDG-compliant paths for rec data, config, and state.

On Linux, uses the XDG Base Directory Specification:

  • Data: ~/.local/share/rec/sessions/
  • Config: ~/.config/rec/config.toml
  • State: ~/.local/state/rec/ (or ~/.local/share/rec/state)

If XDG directories are unavailable (ProjectDirs returns None), falls back to ~/.rec for all paths.

Fields§

§data_dir: PathBuf

Directory for session data files

§config_dir: PathBuf

Directory for configuration files

§config_file: PathBuf

Path to the main config file

§state_dir: PathBuf

Directory for state files (recording state, PID files)

Implementations§

Source§

impl Paths

Source

pub fn new() -> Self

Create new Paths using XDG directories with ~/.rec fallback.

Attempts to use the XDG Base Directory Specification via the directories crate. If that fails (e.g., on systems without proper XDG support), falls back to ~/.rec for all paths.

§Panics

Panics if the home directory cannot be determined (XDG fallback path).

Source

pub fn ensure_dirs(&self) -> Result<()>

Ensure all directories exist, creating them if necessary.

Creates:

  • data_dir (for session files)
  • config_dir (for config.toml)
  • state_dir (for recording state)
§Errors

Returns an error if directory creation fails (e.g., permission denied).

Source

pub fn session_file(&self, id: &str) -> PathBuf

Get the path for a session file by ID.

Session files use the .ndjson extension for NDJSON format.

Source

pub fn backup_file(&self, id: &str) -> PathBuf

Get the path for a session backup file by ID.

Backup files use the .ndjson.bak extension and are created before modifying session data (rename, tag, etc.) to allow recovery if the modification fails.

Trait Implementations§

Source§

impl Clone for Paths

Source§

fn clone(&self) -> Paths

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Paths

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Paths

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl Freeze for Paths

§

impl RefUnwindSafe for Paths

§

impl Send for Paths

§

impl Sync for Paths

§

impl Unpin for Paths

§

impl UnwindSafe for Paths

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.