Struct Store 

pub struct Store { /* private fields */ }

A handle to a .wipe board rooted at a project directory.

Implementations

impl Store

pub fn root(&self) -> &Path

The project root directory (the parent of .wipe).

pub fn wipe_dir(&self) -> PathBuf

Path to the .wipe directory.

pub fn media_dir(&self) -> PathBuf

Path to the media directory (version-controlled attachments).

pub fn cache_dir(&self) -> PathBuf

Path to the (gitignored) cache directory.

pub fn open(root: impl AsRef<Path>) -> Result<Self>

Open an existing board rooted exactly at root (which must contain .wipe).

pub fn discover(start: impl AsRef<Path>) -> Result<Self>

Discover the board by walking up from start until a .wipe directory is found, mirroring how git locates its repository root.

pub fn init( root: impl AsRef<Path>, name: &str, now: DateTime<Utc>, ) -> Result<Self>

Initialize a brand-new board under root with the default (standard) starter content. Fails with Error::AlreadyInitialized if a .wipe directory already exists.

pub fn init_with( root: impl AsRef<Path>, name: &str, now: DateTime<Utc>, starter: Starter, ) -> Result<Self>

Initialize a brand-new board, choosing how much starter content to seed: standard lists+labels, lists only, or a blank board.

pub fn load_board(&self) -> Result<Board>

Load board.json.

pub fn save_board(&self, board: &Board) -> Result<()>

Write board.json deterministically and atomically.

pub fn load_definitions(&self) -> Result<Definitions>

Load definitions.json.

pub fn save_definitions(&self, defs: &Definitions) -> Result<()>

Write definitions.json.

pub fn load_settings(&self) -> Result<Settings>

Load settings.json.

pub fn save_settings(&self, settings: &Settings) -> Result<()>

Write settings.json.

pub fn load_identities(&self) -> Result<Vec<Identity>>

Load identities.json (empty if the file doesn’t exist yet).

pub fn save_identities(&self, identities: &[Identity]) -> Result<()>

Write identities.json.

pub fn load_ticket(&self, id: &str) -> Result<Ticket>

Load a single ticket by ID.

pub fn save_ticket(&self, ticket: &Ticket) -> Result<()>

Write a ticket file.

pub fn delete_ticket(&self, id: &str) -> Result<()>

Delete a ticket file. Errors if it does not exist.

pub fn ticket_ids(&self) -> Result<Vec<String>>

Return all ticket IDs currently on disk, sorted numerically by counter.

pub fn load_all_tickets(&self) -> Result<Vec<Ticket>>

Load every ticket on disk, ordered by ID counter.

pub fn forum_dir(&self) -> PathBuf

Path to the forum directory (.wipe/forum).

pub fn thread_exists(&self, thread_id: &str) -> bool

Whether a thread file already exists on disk for thread_id.

pub fn load_thread(&self, thread_id: &str) -> Result<Thread>

Load a forum thread by its thread ID (e.g. F-1).

pub fn save_thread(&self, thread: &Thread) -> Result<()>

Write a forum thread file.

pub fn delete_thread(&self, thread_id: &str) -> Result<()>

Delete a forum thread file. Errors if it does not exist.

pub fn thread_ids(&self) -> Result<Vec<String>>

All forum thread IDs on disk, sorted numerically by counter.

pub fn load_all_threads(&self) -> Result<Vec<Thread>>

Load every forum thread on disk, ordered by ID counter.

Trait Implementations

impl Clone for Store

fn clone(&self) -> Store

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Store

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

Formats the value using the given formatter.