Struct dot_parser::ast::Graph

pub struct Graph<'a, A = (&'a str, &'a str)> {
    pub strict: bool,
    pub is_digraph: bool,
    pub name: Option<&'a str>,
    pub stmts: StmtList<'a, 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<&'a str>

The name of the Graph, if any.

stmts: StmtList<'a, A>

The statements that describe the graph.

Implementations

impl<'a> Graph<'a>

pub fn read_dot(file: &'a str) -> Result<Self, Error<Rule>>

Read a graph from a DOT file.

impl<'a, A> Graph<'a, A>

pub fn filter_map<F, B>(self, f: F) -> Graph<'a, B>where
    F: Fn(A) -> Option<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.

Trait Implementations

impl<'a, A: Debug> Debug for Graph<'a, A>

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

Formats the value using the given formatter.

impl<'a, A> From<Graph<'a, A>> for Graph<'a, A>where
    A: Clone,

fn from(graph: AstGraph<'a, A>) -> Self

Converts to this type from the input type.

impl<'a, A: Hash> Hash for Graph<'a, 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,

Feeds a slice of this type into the given Hasher.

impl<'a, A: Ord> Ord for Graph<'a, A>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl<'a, A: PartialEq> PartialEq<Graph<'a, A>> for Graph<'a, A>

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

This method tests for self and other values to be equal, and is used by ==.

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

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

impl<'a, A: PartialOrd> PartialOrd<Graph<'a, A>> for Graph<'a, A>

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

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

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

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a, A: Eq> Eq for Graph<'a, A>

impl<'a, A> StructuralEq for Graph<'a, A>

impl<'a, A> StructuralPartialEq for Graph<'a, A>