Struct Home 

pub struct Home { /* private fields */ }

The root of one seat’s pack.

Implementations

impl Home

pub fn new(root: impl Into<PathBuf>) -> Self

A home at root.

pub fn default_root() -> PathBuf

The default home, ~/.grokinside/memory.

pub fn root(&self) -> &Path

The root path.

pub fn db_path(&self) -> PathBuf

The atom database.

pub fn milli_dir(&self) -> PathBuf

The search projection.

pub fn lock_path(&self) -> PathBuf

The single-writer lock.

pub fn workspace_dir(&self, workspace: &str) -> PathBuf

One workspace’s directory.

pub fn user_path(&self) -> PathBuf

The seat-wide card.

pub fn memory_path(&self, workspace: &str) -> PathBuf

One workspace’s card.

pub fn atoms_path(&self, workspace: &str) -> PathBuf

The append-only log, kept for readers that predate the database.

pub fn archive_path(&self, workspace: &str, day: &str) -> PathBuf

Where an overflowing card is archived, one file per day.

pub fn pin_path(&self, workspace: &str) -> PathBuf

The active set for a workspace.

pub fn set_dir(&self, workspace: &str, name: &str) -> PathBuf

One set’s directory inside a workspace.

pub fn set_user_path(&self, workspace: &str, name: &str) -> PathBuf

A set’s own card.

pub fn set_memory_path(&self, workspace: &str, name: &str) -> PathBuf

A set’s own workspace card.

pub fn set_instructions_path(&self, workspace: &str, name: &str) -> PathBuf

A set’s standing instructions.

Trait Implementations

impl Clone for Home

fn clone(&self) -> Home

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Home

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

Formats the value using the given formatter.