Struct Journal 

pub struct Journal {
    pub root: PathBuf,
}

A located journal — a directory tree that contains a .archelon directory.

Fields

root: PathBuf

The directory that directly contains .archelon/.

Implementations

impl Journal

pub fn from_root(root: PathBuf) -> Result<Self>

Create a Journal from an explicit root path.

Returns Err(Error::JournalNotFound) if root does not contain a .archelon directory.

pub fn find_from(start: &Path) -> Result<Self>

Walk up from start until a directory containing .archelon/ is found.

Returns Err(Error::JournalNotFound) if no such directory exists.

pub fn find() -> Result<Self>

Walk up from the current working directory.

pub fn archelon_dir(&self) -> PathBuf

Path to the .archelon directory itself.

pub fn entries_root(&self) -> Result<PathBuf>

Path to the directory that directly contains year subdirectories.

Returns root.join(entries_dir) when entries_dir is configured in .archelon/config.toml, otherwise returns root itself.

pub fn config(&self) -> Result<JournalConfig>

Read the journal config from .archelon/config.toml. Returns the default config if the file does not exist.

pub fn find_entry_by_id(&self, id_prefix: &str) -> Result<PathBuf>

Find a single .md entry file whose stem starts with id_prefix.

Scans self.root and all direct year subdirectories. Returns Err(EntryNotFound) if nothing matches, or Err(AmbiguousId) if more than one file matches.

pub fn collect_entries(&self) -> Result<Vec<PathBuf>>

Collect all .md entry files in the journal: root + year subdirectories.

pub fn journal_id(&self) -> Result<Uuid>

Return the stable journal ID, generating and persisting it if not yet set.

pub fn cache_dir(&self) -> Result<PathBuf>

Machine-local cache directory for this journal.

Resolves to $XDG_CACHE_HOME/archelon/{journal_id}/ (or ~/.cache/archelon/... when XDG_CACHE_HOME is not set). This directory is intentionally outside the journal directory so it is never synced by git, Syncthing, or Nextcloud.

Individual cache files within this directory are named with their schema version (e.g. cache_v2.db) so that old data survives schema upgrades until explicitly removed with archelon cache clean.

Trait Implementations

impl Clone for Journal

fn clone(&self) -> Journal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Journal

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

Formats the value using the given formatter.