Struct World 

pub struct World<'a> {
    pub tasks: &'a [Task],
    pub events: &'a [EventRef],
    pub contacts: &'a [Contact],
    pub vault: Option<&'a Vault>,
    pub drafts: &'a [Draft],
    pub mail: &'a MailIndex,
    pub projects: &'a [Project],
    pub budget: &'a [BudgetRef],
    pub local: &'a LocalLinks,
    pub sites: &'a [Site],
}

Everything Sioul knows, to follow links both ways.

Fields

tasks: &'a [Task]

events: &'a [EventRef]

contacts: &'a [Contact]

vault: Option<&'a Vault>

drafts: &'a [Draft]

mail: &'a MailIndex

projects: &'a [Project]

budget: &'a [BudgetRef]

local: &'a LocalLinks

sites: &'a [Site]

Implementations

impl World<'_>

pub fn canonical(&self, uri: &str) -> String

One address for one thing, however it was written: uid: made a task’s or an event’s, a message’s id bare, a note’s path decoded and without its heading, a project’s sioul:case/ (its address before the name changed) sioul:project/.

pub fn edges(&self) -> Vec<Edge>

Every tie, from every place that holds them.

pub fn related(&self, uri: &str) -> Vec<Related>

What is tied to uri, both ways, each once: tasks first, then events, mail, drafts, notes, contacts, budget lines, projects.

pub fn search( &self, query: &str, kind: Option<Kind>, except: &str, limit: usize, ) -> Vec<Related>

Things to link to: those whose title or detail holds every word typed (case and accents aside), of one kind or all, except left out. Titles starting with what was typed come first, then the newest. Typed nothing: the newest few of each kind.

pub fn describe(&self, uri: &str) -> Related

A thing by its address: its title, a detail, a date, and what opens it.