Struct sodg::Sodg

pub struct Sodg { /* private fields */ }

This struct represents a Simple Object DiGraph (SODG). You add vertices to it, bind them one to one with edges

use sodg::Sodg;
let mut sodg = Sodg::empty();
sodg.add(0).unwrap();
sodg.add(1).unwrap();
sodg.bind(0, 1, "a").unwrap();
sodg.add(2).unwrap();
sodg.bind(1, 2, "b").unwrap();
assert_eq!(2, sodg.find(0, "a.b").unwrap());

Implementations

impl Sodg

pub fn inspect(&self, loc: &str) -> Result<String>

Finds an object by the provided locator and prints its tree of sub-objects and edges. Mostly used for testing.

impl Sodg

pub fn merge(&mut self, g: &Sodg)

Merge this new graph into itself.

impl Sodg

pub fn empty() -> Self

Makes an empty Sodg, with no vertices and no edges.

pub fn max(&self) -> u32

Get max ID of a vertex.

impl Sodg

pub fn add(&mut self, v1: u32) -> Result<()>

Add a new vertex v1 to the Sodg:

use sodg::Sodg;
let mut sodg = Sodg::empty();
sodg.add(0).unwrap();
sodg.add(42).unwrap();
sodg.bind(0, 42, "hello").unwrap();

pub fn bind(&mut self, v1: u32, v2: u32, a: &str) -> Result<()>

Makes an edge e1 from vertex v1 to vertex v2 and puts a label on it. If the label is not equal to "ρ", makes two backward edges from v2 to v1 and label them as "ρ" an "𝜎".

use sodg::Sodg;
let mut sodg = Sodg::empty();
sodg.add(0).unwrap();
sodg.add(42).unwrap();
sodg.bind(0, 42, "forward").unwrap();
sodg.bind(42, 0, "backward").unwrap();

pub fn put(&mut self, v: u32, d: Hex) -> Result<()>

Set vertex data.

use sodg::hex::Hex;
use sodg::Sodg;
let mut sodg = Sodg::empty();
sodg.add(42).unwrap();
sodg.put(42, Hex::from_str("hello, world!")).unwrap();

pub fn data(&self, v: u32) -> Result<Hex>

Read vertex data.

use sodg::hex::Hex;
use sodg::Sodg;
let mut sodg = Sodg::empty();
sodg.add(42).unwrap();
let data = Hex::from_str("hello, world!");
sodg.put(42, data.clone()).unwrap();
assert_eq!(data, sodg.data(42).unwrap());

pub fn kids(&self, v: u32) -> Result<Vec<(String, u32)>>

Find all kids of a vertex.

pub fn kid(&self, v: u32, a: &str) -> Option<u32>

Find a kid of a vertex, by its edge name.

use sodg::Sodg;
let mut sodg = Sodg::empty();
sodg.add(0).unwrap();
sodg.add(42).unwrap();
sodg.bind(0, 42, "k").unwrap();
assert_eq!(42, sodg.kid(0, "k").unwrap());
assert!(sodg.kid(0, "another").is_none());

pub fn find(&self, v1: u32, loc: &str) -> Result<u32>

Find a vertex in the Sodg by its locator.

use sodg::Sodg;
let mut sodg = Sodg::empty();
sodg.add(0).unwrap();
sodg.add(1).unwrap();
sodg.bind(0, 1, "a").unwrap();
sodg.add(2).unwrap();
sodg.bind(1, 2, "b").unwrap();
assert_eq!(2, sodg.find(0, "a.b").unwrap());

impl Sodg

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

Save the entire Sodg into a binary file. The entire Sodg can be restored from the file. Returns the size of the file just saved.

pub fn load(path: &Path) -> Result<Sodg>

Load the entire Sodg from a binary file previously created by save().

impl Sodg

pub fn slice(&mut self, loc: &str) -> Result<Sodg>

Take a slice of the Sodg, keeping only the vertex specified by the locator.

impl Sodg

pub fn to_xml(&self) -> Result<String>

Make XML graph.

impl Sodg

pub fn alert_on(&mut self, a: Alert)

Attach a new alert to this SODG.

pub fn alerts_off(&mut self)

Disable all alerts.

pub fn alerts_on(&mut self)

Enable all alerts.

Trait Implementations

impl Debug for Sodg

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Sodg

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where
    __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Sodg

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

Serialize this value into the given Serde serializer.