Struct portgraph::PortIndex

#[repr(transparent)]
pub struct PortIndex(_);

Index of a port within a PortGraph.

Restricted to be at most 2^31 - 1 to allow more efficient encodings of the port graph structure. This type admits the null pointer optimization so that Option<PortIndex> takes as much space as a PortIndex by itself.

Implementations

impl PortIndex

pub fn new(index: usize) -> Self

Creates a new port index from a usize.

Panics

Panics if the index is greater than 2^31 - 2.

pub fn index(self) -> usize

Returns the index as a usize.

Trait Implementations

impl Clone for PortIndex

fn clone(&self) -> PortIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PortIndex

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

Formats the value using the given formatter.

impl Default for PortIndex

fn default() -> Self

Returns the “default value” for a type.

impl From<PortIndex> for usize

fn from(index: PortIndex) -> Self

Converts to this type from the input type.

impl Hash for PortIndex

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<N, P> Index<PortIndex> for Weights<N, P>where N: Clone, P: Clone,

type Output = P

The returned type after indexing.

fn index(&self, key: PortIndex) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<N, P> IndexMut<PortIndex> for Weights<N, P>where N: Clone, P: Clone,

fn index_mut(&mut self, key: PortIndex) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl Ord for PortIndex

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

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

fn partial_cmp(&self, other: &PortIndex) -> 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 TryFrom<usize> for PortIndex

type Error = IndexError

The type returned in the event of a conversion error.

fn try_from(index: usize) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for PortIndex

impl Eq for PortIndex

impl StructuralEq for PortIndex

impl StructuralPartialEq for PortIndex