Enum FlowDirection 

pub enum FlowDirection {
    Source,
    Sink,
    SourceAndSink,
    NotDefined,
}

Which way material or energy moves through a port.

A missing direction is FlowDirection::NotDefined rather than an assumed default. Guessing Source would invent a direction the file never stated and orient edges that have no stated orientation, which is worse than admitting the network is partly undirected.

Variants

Source

Material leaves the element through this port.

Sink

Material enters the element through this port.

SourceAndSink

Bidirectional.

NotDefined

Stated as NOTDEFINED, or not stated at all.

Implementations

impl FlowDirection

pub fn emits(self) -> bool

Whether material may LEAVE the element through this port.

NotDefined is false in both directions. That is deliberate: an undirected port cannot orient an edge, and pretending it can would manufacture flow paths a reviewer cannot trace back to the file.

pub fn accepts(self) -> bool

Whether material may ENTER the element through this port.

pub fn is_stated(self) -> bool

Whether the file stated a direction at all.

Trait Implementations

impl Clone for FlowDirection

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 FlowDirection

impl Debug for FlowDirection

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

Formats the value using the given formatter.

impl Eq for FlowDirection

impl Ord for FlowDirection

fn cmp(&self, other: &Self) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for FlowDirection

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for FlowDirection

fn partial_cmp(&self, other: &Self) -> 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 StructuralPartialEq for FlowDirection