Enum dfir_lang::graph::PortIndexValue

pub enum PortIndexValue {
    Int(IndexInt),
    Path(ExprPath),
    Elided(Option<Span>),
}

Helper struct for PortIndex which keeps span information for elided ports.

Variants

Int(IndexInt)

An integer value: [0], [1], etc. Can be negative although we don’t use that (2023-08-16).

Path(ExprPath)

A name or path. [pos], [neg], etc. Can use :: separators but we don’t use that (2023-08-16).

Elided(Option<Span>)

Elided, unspecified port. We have this variant, rather than wrapping in Option, in order to preserve the Span information.

Implementations

impl PortIndexValue

pub fn from_ported<Inner>(ported: Ported<Inner>) -> (Self, Inner, Self)

where Inner: Spanned,

For a Ported value like [port_in]name[port_out], get the port_in and port_out as PortIndexValues.

pub fn is_specified(&self) -> bool

Returns true if self is not PortIndexValue::Elided.

pub fn combine(self, other: Self) -> Result<Self, Self>

Return Err(self) if there is a conflict.

pub fn as_error_message_string(&self) -> String

Formats self as a human-readable string for error messages.

pub fn span(&self) -> Span

Returns the span of this port value.

Trait Implementations

impl Clone for PortIndexValue

fn clone(&self) -> PortIndexValue

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PortIndexValue

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PortIndexValue

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PortIndexValue

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

Formats the value using the given formatter.

impl From<PortIndex> for PortIndexValue

fn from(value: PortIndex) -> Self

Converts to this type from the input type.

impl Ord for PortIndexValue

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

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

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for PortIndexValue

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for PortIndexValue