Struct GraphDoc 

pub struct GraphDoc {
    pub nodes: Vec<GraphNode>,
    pub edges: Vec<EdgeDoc>,
}

Fields

nodes: Vec<GraphNode>

edges: Vec<EdgeDoc>

Implementations

impl GraphDoc

pub fn is_empty(&self) -> bool

pub fn node(&self, id: &str) -> Option<&GraphNode>

pub fn node_mut(&mut self, id: &str) -> Option<&mut GraphNode>

pub fn contains(&self, id: &str) -> bool

pub fn input(&self, id: &str) -> Option<&str>

The node feeding id.

pub fn outputs(&self, id: &str) -> Vec<&str>

The nodes id feeds, in edge order.

pub fn path(&self, id: &str) -> Option<Vec<String>>

id’s chain from its source: [source, op…, id]; None when it does not reach one.

pub fn ancestors(&self, id: &str) -> BTreeSet<String>

Every node upstream of id.

pub fn descendants(&self, id: &str) -> BTreeSet<String>

Every node downstream of id.

pub fn fresh_id(&self, base: &str) -> String

An id not used yet: base itself, else base1, base2, …

pub fn numbered_id(&self, prefix: &str, taken: impl Fn(&str) -> bool) -> String

prefix1, prefix2, … (sources s1, writes w1).

pub fn next_row(&self) -> f32

The y of a new row under every node.

pub fn connect(&mut self, from: &str, to: &str) -> Result<(), String>

Connects from’s output to to’s input (replacing to’s input).

pub fn disconnect(&mut self, to: &str)

Removes to’s input.

pub fn remove(&mut self, id: &str)

Removes a node and its edges.

pub fn remove_bridging(&mut self, id: &str)

Removes a node, its input feeding what it fed.

pub fn unlink_bridging(&mut self, id: &str)

Takes a node out of its chains (its input feeds what it fed); the node stays, unlinked.

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

Puts id on the edge a → b (a → id → b).

pub fn chain( &self, id: &str, recipes: &Recipes, ) -> Option<(RecordingRef, Vec<OpDoc>)>

The recording and ops (enabled or not) of id’s chain; a recipe node gives its ops (<node>.<op>, its overrides applied).

pub fn compile(&self, recipes: &Recipes) -> Vec<ViewDoc>

The views: each view node that reaches a source, in node order.

pub fn from_views(views: &[ViewDoc]) -> Self

The graph of a document that has views only (written before the graph, or by hand): one row per view, its source, its ops, the view.

Trait Implementations

impl Clone for GraphDoc

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GraphDoc

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

Formats the value using the given formatter.

impl Default for GraphDoc

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for GraphDoc

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for GraphDoc

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for GraphDoc

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for GraphDoc

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 GraphDoc