Enum scir::Direction

pub enum Direction {
    Input,
    Output,
    InOut,
}

Port directions.

Variants

Input

Input.

Output

Output.

InOut

Input or output.

Represents ports whose direction is not known at generator elaboration time (e.g. the output of a tristate buffer).

Implementations

impl Direction

pub fn flip(&self) -> Self

Returns the flipped direction.

Direction::InOut is unchanged by flipping.

Examples

use scir::Direction;
assert_eq!(Direction::Input.flip(), Direction::Output);
assert_eq!(Direction::Output.flip(), Direction::Input);
assert_eq!(Direction::InOut.flip(), Direction::InOut);

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

Test if two nodes of the respective directions are allowed be connected to each other.

Examples

use scir::Direction;
assert_eq!(Direction::Input.is_compatible_with(Direction::Output), true);
assert_eq!(Direction::Output.is_compatible_with(Direction::Output), false);
assert_eq!(Direction::Output.is_compatible_with(Direction::InOut), true);

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

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

Formats the value using the given formatter.

impl Default for Direction

fn default() -> Direction

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Direction

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Direction

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

Formats the value using the given formatter.

impl Ord for Direction

fn cmp(&self, other: &Direction) -> 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 + PartialOrd,

Restrict a value to a certain interval.

impl PartialEq for Direction

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

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for Direction

impl Eq for Direction

impl StructuralPartialEq for Direction