Struct Dirs 

pub struct Dirs {
    pub data: PathBuf,
    pub state: PathBuf,
    pub cache: PathBuf,
}

Where the filter keeps its files. standard() is Sioul’s own folders; tests give their own.

Fields

data: PathBuf

$XDG_DATA_HOME/sioul/spam: the corpus, outside material, the language model, the table.

state: PathBuf

$XDG_STATE_HOME/sioul/spam: every device’s label log and log of what the filter moved, the last training’s summary.

cache: PathBuf

$XDG_CACHE_HOME/sioul/spam: the tokenized corpus while fastText reads it.

Implementations

impl Dirs

pub fn standard() -> Dirs

pub fn under(root: &Path) -> Dirs

Every folder under one root (tests).

pub fn corpus(&self) -> PathBuf

The training corpus: private, never shared, never shown to an AI agent.

pub fn external(&self) -> PathBuf

Outside training material (external): private, never shared, never shown to an AI agent.

pub fn language(&self) -> PathBuf

The fastText model: private, never shared (it holds the vocabulary in plain text).

pub fn table(&self) -> PathBuf

The reduced table every device reads.

pub fn previous_table(&self) -> PathBuf

The table before the last one replaced it.

pub fn labels(&self) -> PathBuf

The label logs, one per device: your junk, not-junk, “Spam”, “Not spam” and blocks.

pub fn moved(&self) -> PathBuf

What your own filter moved into a Junk folder, one log per device: learned as all Junk mail is, until you say otherwise.

pub fn flagged(&self) -> PathBuf

What your own filter flagged where it is, one log per device: a probable spam learned as spam, a maybe spam left out, until you say.

pub fn trained(&self) -> PathBuf

The last training’s summary, for the settings.

Trait Implementations

impl Clone for Dirs

fn clone(&self) -> Dirs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Dirs

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

Formats the value using the given formatter.

impl Eq for Dirs

impl PartialEq for Dirs

fn eq(&self, other: &Dirs) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Dirs