Struct TSGraph

pub struct TSGraph {
    pub headers: Vec<Header>,
    pub graphs: HashMap<BString, GraphSection>,
    pub links: Vec<InterGraphLink>,
    /* private fields */
}

The complete transcript segment graph containing multiple graph sections

Fields

headers: Vec<Header>

graphs: HashMap<BString, GraphSection>

links: Vec<InterGraphLink>

Implementations

impl TSGraph

pub fn builder() -> TSGraphBuilder

Create an instance of TSGraph using the builder syntax

impl TSGraph

pub fn new() -> Self

Create a new empty TSGraph

pub fn from_reader<R: BufRead>(reader: R) -> Result<Self>

pub fn from_file<P: AsRef<Path>>(path: P) -> Result<Self>

Parse a TSG file and construct a TSGraph

pub fn to_writer<W: Write>(&self, writer: &mut W) -> Result<()>

Write the TSGraph to writer

pub fn to_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

Write the TSGraph to a TSG file

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

Get a graph section by its ID

pub fn graph_mut(&mut self, id: &str) -> Option<&mut GraphSection>

pub fn default_graph(&self) -> Option<&GraphSection>

get default graph

pub fn default_graph_mut(&mut self) -> Option<&mut GraphSection>

pub fn node(&self, graph_id: &str, node_id: &str) -> Option<&NodeData>

Get a node by its ID and graph ID

pub fn edge(&self, graph_id: &str, edge_id: &str) -> Option<&EdgeData>

Get an edge by its ID and graph ID

pub fn chain_nodes( &self, graph_id: &str, chain_id: &BStr, ) -> Option<Vec<NodeIndex>>

Get the nodes in a chain in order

pub fn chain_edges( &self, graph_id: &str, chain_id: &BStr, ) -> Option<Vec<EdgeIndex>>

Get the edges in a chain in order

pub fn find_node_id_by_idx( &self, graph_id: &str, node_idx: NodeIndex, ) -> Option<&BString>

Helper method to find a node’s ID by its index

pub fn node_by_idx( &self, graph_id: &str, node_idx: NodeIndex, ) -> Option<&NodeData>

pub fn edge_by_idx( &self, graph_id: &str, edge_idx: EdgeIndex, ) -> Option<&EdgeData>

pub fn nodes(&self, graph_id: &str) -> Vec<&NodeData>

Get all nodes in the graph

pub fn edges(&self, graph_id: &str) -> Vec<&EdgeData>

Get all edges in the graph

pub fn traverse_by_id(&self, graph_id: &str) -> Result<Vec<TSGPath<'_>>>

Traverse the graph and return all valid paths from source nodes to sink nodes.

pub fn traverse_all_graphs(&self) -> Result<Vec<TSGPath<'_>>>

traverse all graphs

pub fn to_dot_by_id( &self, graph_id: &str, node_label: bool, edge_label: bool, ) -> Result<String>

pub fn to_json_by_id(&self, graph_id: &str) -> Result<Value>

Trait Implementations

impl Clone for TSGraph

fn clone(&self) -> TSGraph

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TSGraph

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

Formats the value using the given formatter.

impl Default for TSGraph

fn default() -> TSGraph

Returns the “default value” for a type.

impl FromStr for TSGraph

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl TSGraphAnalysis for TSGraph

fn summarize(&self) -> Result<BString>