Struct sodg::Script

pub struct Script { /* private fields */ }

A wrapper of a plain text with graph-modifying instructions.

For example, you can pass the following instructions to it:

ADD(0);
ADD($ν1); # adding new vertex
BIND(0, $ν1, foo);
PUT($ν1, d0-bf-D1-80-d0-B8-d0-b2-d0-b5-d1-82);

In the script you can use “variables”, similar to $ν1 used in the text above. They will be replaced by autogenerated numbers during the deployment of this script to a Sodg.

Implementations

impl Script

pub fn from_str(s: &str) -> Script

Make a new one, parsing a string with instructions.

Instructions must be separated by semicolon. There are just three of them possible: ADD, BIND, and PUT. The arguments must be separated by a comma. An argument may either be 1) a positive integer (possibly prepended by ν), 2) a variable started with $, 3) an attribute name, or 4) data in XX-XX-... hexadecimal format.

For example:

use sodg::Script;
use sodg::Sodg;
let mut s = Script::from_str(
  "ADD(0); ADD($ν1); BIND(ν0, $ν1, foo);"
);
let mut g = Sodg::empty();
let total = s.deploy_to(&mut g).unwrap();
assert_eq!(1, g.kid(0, "foo").unwrap().0);

pub fn from_string(s: String) -> Script

Make a new one, parsing a String with instructions.

pub fn deploy_to(&mut self, g: &mut Sodg) -> Result<usize>

Deploy the entire script to the Sodg.