Struct LocalLinks 

pub struct LocalLinks {
    pub links: Vec<Edge>,
}

Links Sioul keeps itself, for what cannot hold them.

Fields

links: Vec<Edge>

Implementations

impl LocalLinks

pub fn default_path() -> PathBuf

$XDG_DATA_HOME/sioul/links.toml.

pub fn load(path: &Path) -> LocalLinks

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

pub fn change( path: &Path, f: impl FnOnce(&mut LocalLinks) -> bool, ) -> Result<bool, String>

The ties kept at path changed by f, under the file’s lock (filelock, the one the sharing takes to write this file), read again once it is held: the window, an agent (sioul mcp) and the sharing writing at once never write an older copy over another’s tie. f says whether it changed anything; the file is written only then. Returns what f said. Every change to the file goes through here, never load then save (which hold no lock: one held inside would wait for itself).

pub fn add_all(path: &Path, edges: &[Edge]) -> Result<bool, String>

Ties added to those kept at path, each once (change); whether any was new.

pub fn add(&mut self, from: &str, to: &str, how: &str)

Adds a link once.

pub fn remove(&mut self, a: &str, b: &str)

Removes the links between two things, either way.

pub fn untie(&mut self, world: &World<'_>, a: &str, b: &str) -> bool

Takes out every tie between a and b, however each end was written; returns whether there was one.

Trait Implementations

impl Clone for LocalLinks

fn clone(&self) -> LocalLinks

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LocalLinks

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

Formats the value using the given formatter.

impl Default for LocalLinks

fn default() -> LocalLinks

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for LocalLinks

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for LocalLinks

impl PartialEq for LocalLinks

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for LocalLinks

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for LocalLinks