Enum Direction 

pub enum Direction {
    LeftToRight,
    TopToBottom,
    RightToLeft,
    BottomToTop,
}

The direction in which a flowchart flows.

Variants

LeftToRight

Left-to-right (LR).

TopToBottom

Top-to-bottom (TD or TB).

RightToLeft

Right-to-left (RL).

BottomToTop

Bottom-to-top (BT).

Implementations

impl Direction

pub fn parse(s: &str) -> Option<Self>

Parse a direction keyword, case-insensitive.

Arguments

• s — a direction token such as "LR", "TD", "TB", "RL", or "BT".

Returns

Some(Direction) if the keyword is recognised, None otherwise.

Examples

use mermaid_text::Direction;

assert_eq!(Direction::parse("LR"), Some(Direction::LeftToRight));
assert_eq!(Direction::parse("td"), Some(Direction::TopToBottom)); // case-insensitive
assert_eq!(Direction::parse("TB"), Some(Direction::TopToBottom));
assert_eq!(Direction::parse("RL"), Some(Direction::RightToLeft));
assert_eq!(Direction::parse("BT"), Some(Direction::BottomToTop));
assert_eq!(Direction::parse("XX"), None);

pub fn is_horizontal(self) -> bool

Returns true if the primary flow axis is horizontal (LR or RL).

Examples

use mermaid_text::Direction;

assert!(Direction::LeftToRight.is_horizontal());
assert!(Direction::RightToLeft.is_horizontal());
assert!(!Direction::TopToBottom.is_horizontal());
assert!(!Direction::BottomToTop.is_horizontal());

Trait Implementations

impl Clone for Direction

fn clone(&self) -> Direction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Direction

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

Formats the value using the given formatter.

impl Hash for Direction

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 PartialEq for Direction

fn eq(&self, other: &Direction) -> 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 Copy for Direction

impl Eq for Direction

impl StructuralPartialEq for Direction