Struct Node 

pub struct Node { /* private fields */ }

Implementations

impl Node

pub fn new() -> Self

Construct Node

Example

use pretty_graph::Node;

let node = Node::new();

impl Node

pub fn from( payload: Option<Vec<(&'static str, &'static str)>>, node_links: Option<Vec<(&'static str, Node)>>, ) -> Self

Construct Node from payload & link vectors

Example

use pretty_graph::Node;

let node_1 = Node::from(None, None); // Params are optional
let node_2 = Node::from(
    Some(vec![
        ("key1", "value1"),
        ("key2", "value2")
    ]),
    Some(vec![
        ("node_1", node_1.clone())
    ])
);

impl Node

pub fn set(&self, k: &str, v: &str)

Set node value

Example

use pretty_graph::Node;

let node = Node::new();
node.set("key", "value");

pub fn get(&self, k: &str) -> Option<String>

Get node value

Example

use pretty_graph::Node;

let node = Node::new();
node.set("key", "value");
let v = node.get("key");

pub fn remove(&self, k: &str) -> Option<String>

Remove node value

Example

use pretty_graph::Node;

let node = Node::new();
node.set("key", "value");
let v = node.remove("key");

pub fn keys(&self) -> Vec<String>

Get payload keys

Example

use pretty_graph::Node;

let node = Node::new();
node.set("key1", "value1");
node.set("key2", "value2");

let keys = vec!["key1", "key2"];

for k in node.keys().iter() {
   assert!(keys.contains(&k.as_str()));
}

impl Node

pub fn link(&self, link_as: &str, node: Node)

Link one node to another

Example

use pretty_graph::Node;

let node_1 = Node::new();
let node_2 = Node::new();
node_2.link("node_1", node_1);

pub fn unlink(&self, k: &str)

Unlink one node from another

Example

use pretty_graph::Node;

let node_1 = Node::new();
let node_2 = Node::new();
node_2.unlink("node_1");

pub fn link_keys(&self) -> Vec<String>

Get linked node keys

Example

use pretty_graph::Node;

let node_3 = Node::new();
let node_2 = Node::new();
let node_1 = Node::new();

node_1.link("node_2", node_2);
node_1.link("node_3", node_3);

for k in node_1.link_keys() {
   // ...
}

pub fn node_by_key(&self, k: &str) -> Option<Node>

Get to node by link chane

Example

use pretty_graph::Node;

let node_1 = Node::from(None, None);
let node_2 = Node::from(
    None,
    Some(vec![
        ("node_1", node_1.clone())
    ])
);


let node_1: Option<Node> = node_2.node_by_key("node_1");

pub fn node_by_chain(&self, route: Vec<&str>) -> Option<Node>

Get to node by link chane

Example

use pretty_graph::Node;

let node_1 = Node::from(None, None);
let node_2 = Node::from(
    None,
    Some(vec![
        ("node_1", node_1.clone())
    ])
);

let node_3 = Node::from(
    None,
    Some(vec![
        ("node_2", node_2.clone())
    ])
);

let node_1: Option<Node> = node_3.node_by_chain(vec!["node_2", "node_1"]);

impl Node

pub fn new_vec() -> Self

Construct Node

Example

use pretty_graph::Node;

let node = Node::new_vec();

impl Node

pub fn vec_from( payload: Option<Vec<&str>>, node_links: Option<Vec<Node>>, ) -> Self

Construct Node from payload & link vectors

Example

use pretty_graph::Node;

let node_1 = Node::new();
let node_2 = Node::vec_from(
    Some(vec![
        "value1",
        "value2"
    ]),
    Some(vec![
        node_1
    ])
);

impl Node

pub fn push_str(&self, v: &str)

Set node value

Example

use pretty_graph::Node;

let node = Node::new_vec();
node.push_str("value");

pub fn pop_string(&self) -> Option<String>

Pop string from vector node

Example

use pretty_graph::Node;

let node = Node::new_vec();
node.push_str("value");
let s = node.pop_string();

pub fn get_string_by_index(&self, i: usize) -> Option<String>

Get node value

Example

use pretty_graph::Node;

let node = Node::new_vec();
node.push_str("value");
let v = node.get_string_by_index(0);

pub fn remove_string_by_index(&self, i: usize) -> String

Remove node value

Example

use pretty_graph::Node;

let node = Node::new_vec();
node.push_str("value");
let v = node.remove_string_by_index(0);

impl Node

pub fn node_by_index(&self, i: usize) -> Option<Node>

Get node by index

Example

use pretty_graph::Node;

let node_1 = Node::new_vec();
let node_2 = Node::new();
node_1.push_node(node_2);
let node_2 = node_1.node_by_index(0);

pub fn push_node(&self, node: Node)

Push node to vector node

Example

use pretty_graph::Node;

let node_1 = Node::new_vec();
let node_2 = Node::new();
node_1.push_node(node_2);

pub fn pop_node(&self) -> Option<Node>

Pop node from vector node

Example

use pretty_graph::Node;

let node_1 = Node::new_vec();
let node_2 = Node::new();
node_1.push_node(node_2);
let node_2 = node_1.pop_node();

pub fn remove_by_node_by_index(&self, i: usize) -> Node

Remove node by index from vector node

Example

use pretty_graph::Node;

let node_1 = Node::new_vec();
let node_2 = Node::new();
node_1.push_node(node_2);
let node_2 = node_1.remove_by_node_by_index(0);

impl Node

pub fn linked_nodes(&self) -> Vec<Node>

Get linked nodes

Example

use pretty_graph::Node;

let node_3 = Node::new();
let node_2 = Node::new();
let node_1 = Node::new();

node_1.link("node_2", node_2);
node_1.link("node_3", node_3);

for k in node_1.linked_nodes() {
   // ...
}

impl Node

pub fn values(&self) -> Vec<String>

Get payload values

Example

use pretty_graph::Node;

let node = Node::new();
node.set("key1", "value1");
node.set("key2", "value2");

let values = vec!["value1", "value2"];

for v in node.values().iter() {
   assert!(values.contains(&v.as_str()));
}

pub fn clear(&self)

Clear payload

Example

use pretty_graph::Node;

let node = Node::new();

node.clear();

pub fn len(&self) -> usize

Get payload len

Example

use pretty_graph::Node;

let node = Node::new_vec();
node.push_str("Hi!");

println!("len: {}", node.len());

let node = Node::new();
node.set("msg", "Hi!");

println!("len: {}", node.len());

pub fn contains_string(&self, v: &String) -> bool

Check if vector node contains string

Example

use pretty_graph::Node;

let node = Node::new();
node.set("key", "value");
let v = node.contains_string(&"value".to_string());

let node = Node::new_vec();
node.push_str("value");
let v = node.contains_string(&"value".to_string());

Trait Implementations

impl Clone for Node

fn clone(&self) -> Node

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Node

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

Formats the value using the given formatter.

impl Universal for Node

fn get_str_vector_by_key_or(&self, k: &str, or: Vec<&str>) -> Vec<String>

Get node by key and then trys to return its values or vector you set into or argument. Example