Struct TraversalParam 

pub struct TraversalParam {
    pub name: &'static str,
    pub ty: TraversalParamType,
    pub default: Option<Value>,
    pub doc: &'static str,
}

One parameter of a traversal, besides the graph.

Fields

name: &'static str

ty: TraversalParamType

default: Option<Value>

The value when the argument is not given; None if it must be given.

doc: &'static str

One line on what it does.

Implementations

impl TraversalParam

pub fn takes_nodes(&self) -> bool

Whether the parameter is a node id or a set of them.

pub fn is_weight(&self) -> bool

Whether the parameter is the weight expression.

pub fn shown_default(&self) -> String

The parameter as a signature shows it: its default, or a placeholder for a required one.

Trait Implementations

impl Clone for TraversalParam

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for TraversalParam

impl Debug for TraversalParam

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

Formats the value using the given formatter.