Struct Letters 

pub struct Letters {
    pub root: PathBuf,
    pub list: Vec<Letter>,
}

The letters of a notes folder.

Fields

root: PathBuf

list: Vec<Letter>

Implementations

impl Letters

pub fn folder(root: &Path) -> PathBuf

pub fn change<R>( root: &Path, change: impl FnOnce(&mut Letters) -> R, ) -> Result<R, String>

Read, changed by change and written back, all under the file’s lock (the window’s own; the sharing carries the file as a note): a change is set over the file as it is then. Returns what change returns.

pub fn try_change<R>( root: &Path, change: impl FnOnce(&mut Letters) -> Result<R, String>, ) -> Result<R, String>

The same, written back only when change succeeds.

pub fn load(root: &Path) -> Result<Letters, String>

pub fn get(&self, id: &str) -> Option<&Letter>

pub fn put(&mut self, letter: Letter)

pub fn file_path(&self, letter: &Letter) -> PathBuf

A scan’s file, where it is on this computer.

pub fn text(&self, letter: &Letter) -> String

Its text, as read.

pub fn save_text(&self, id: &str, text: &str) -> Result<(), String>

pub fn file_away(&self, letter: &mut Letter) -> Result<(), String>

Its scan moved out of the inbox into letters/<year>/, named by its day, sender and kind.

pub fn save(&self) -> Result<(), String>

Written whole, under the file’s lock.

fn write(&self) -> Result<(), String>

Trait Implementations

impl Clone for Letters

fn clone(&self) -> Letters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Letters

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

Formats the value using the given formatter.

impl Default for Letters

fn default() -> Letters

Returns the “default value” for a type.