Enum portgraph::PortOffset

pub enum PortOffset {
    Incoming(NonZeroU16),
    Outgoing(u16),
}

Port offset in a node

Variants

Incoming(NonZeroU16)

Input to a node

The index is shifted by one to allow for null pointer optimizations.

Outgoing(u16)

Output from a node.

Implementations

impl PortOffset

pub fn new(direction: Direction, offset: usize) -> Self

Creates a new port offset.

pub fn new_incoming(offset: usize) -> Self

Creates a new incoming port offset.

pub fn new_outgoing(offset: usize) -> Self

Creates a new outgoing port offset.

pub fn direction(self) -> Direction

Returns the direction of the port.

pub fn index(self) -> usize

Returns the offset of the port.

Trait Implementations

impl Clone for PortOffset

fn clone(&self) -> PortOffset

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PortOffset

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

Formats the value using the given formatter.

impl Default for PortOffset

fn default() -> Self

Returns the “default value” for a type.

impl Hash for PortOffset

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 Ord for PortOffset

fn cmp(&self, other: &PortOffset) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Selfwhere Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<PortOffset> for PortOffset

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

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

impl Eq for PortOffset

impl StructuralEq for PortOffset

impl StructuralPartialEq for PortOffset