Struct Graph

pub struct Graph<A> {
    pub strict: bool,
    pub is_digraph: bool,
    pub name: Option<String>,
    pub stmts: StmtList<A>,
}

This structure is an AST for the DOT graph language. The generic A denotes the type of attributes. By default (and when parsing), it is (&'a str, &'a str), i.e. two strings, one for the key and one for the value of the attribute. The library provides functions to map from one type to an other.

Fields

strict: bool

Specifies if the Graph is strict or not. A “strict” graph must not contain the same edge multiple times. Notice that, for undirected edge, an edge from A to B and an edge from B to A are equals.

is_digraph: bool

Specifies if the Graph is directed.

name: Option<String>

The name of the Graph, if any.

stmts: StmtList<A>

The statements that describe the graph.

Implementations

impl Graph<(String, String)>

pub fn from_file<'a, P>(p: P) -> Result<Self, GraphFromFileError<'a>>

where P: AsRef<Path>,

Parses a graph from a file, which path is given. Notice that when doing so, attributes are of type (String, String), not the default (&'a str, &'a str), since we are reading and taking ownership of the content of the file.

impl<A> Graph<A>

pub fn filter_map<B>(self, f: &dyn Fn(A) -> Option<B>) -> Graph<B>

Filter and map attributes. The main intended usage of this function is to convert attributes as &'a str into an enum, e.g. to convert ["label"="whatever", "color"="foo"] into [Attr::Label(whatever), Attr::Color(foo)].

To take into account non-standard attributes, the Attr enum has to be provided by the user.

pub fn get_node_ids(self) -> HashSet<NodeID>

Returns all NodeIDs that appear in the graph.

Trait Implementations

impl<A: Clone> Clone for Graph<A>

fn clone(&self) -> Graph<A>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<A: Debug> Debug for Graph<A>

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

Formats the value using the given formatter.

impl<A: Hash> Hash for Graph<A>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<A: Ord> Ord for Graph<A>

fn cmp(&self, other: &Graph<A>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl<A: PartialEq> PartialEq for Graph<A>

fn eq(&self, other: &Graph<A>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<A: PartialOrd> PartialOrd for Graph<A>

fn partial_cmp(&self, other: &Graph<A>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl<'a> TryFrom<&'a str> for Graph<(&'a str, &'a str)>

type Error = Error<Rule>

The type returned in the event of a conversion error.

fn try_from(s: &'a str) -> Result<Self, PestError>

Performs the conversion.

impl<'a, A> TryFrom<Pair<'a, Rule>> for Graph<A>

where AList<A>: TryFrom<Pair<'a, Rule>, Error = ParseError<'a>>,

type Error = ParseError<'a>

The type returned in the event of a conversion error.

fn try_from(p: Pair<'a, Rule>) -> Result<Self, ParseError<'a>>

Performs the conversion.

impl<A: Eq> Eq for Graph<A>

impl<A> StructuralPartialEq for Graph<A>