Enum tydi::logical::Direction

pub enum Direction {
    Forward,
    Reverse,
}

Direction of a stream.

Reference

Variants

Forward

Forward indicates that the child stream flows in the same direction as its parent, complementing the data of its parent in some way.

Reverse

Reverse indicates that the child stream acts as a response channel for the parent stream. If there is no parent stream, Forward indicates that the stream flows in the natural source to sink direction of the logical stream, while Reverse indicates a control channel in the opposite direction. The latter may occur for instance when doing random read access to a memory; the first stream carrying the read commands then flows in the sink to source direction.

Trait Implementations

impl Clone for Direction

fn clone(&self) -> Direction

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Direction

impl Debug for Direction

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

Formats the value using the given formatter.

impl Default for Direction

fn default() -> Self

Returns the "default value" for a type.

impl Eq for Direction

impl FromStr for Direction

type Err = Error

The associated error which can be returned from parsing.

fn from_str(input: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl PartialEq<Direction> for Direction

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Reverse for Direction

fn reverse(&mut self)

Reverse this direction.

Examples

use tydi::{Reverse, Reversed, logical::Direction};

let mut forward = Direction::Forward;
let mut reverse = Direction::Reverse;

forward.reverse();
assert_eq!(forward, reverse);

forward.reverse();
assert_eq!(forward, reverse.reversed());

impl StructuralEq for Direction

impl StructuralPartialEq for Direction