Struct PortDescriptor

pub struct PortDescriptor {
    pub direction: PortDirection,
    pub name: Option<String>,
    pub label: Option<String>,
    pub type: Option<String>,
    pub id: PortID,
    pub state: PortState,
}

A descriptor for a block port.

Fields

direction: PortDirection

The dataflow direction of this port.

name: Option<String>

The machine-readable name of this port, if any.

label: Option<String>

A human-readable label for this port, if any.

type: Option<String>

The data type for messages on this port.

id: PortID

The unique identifier for this port.

state: PortState

The current state of this port.

Implementations

impl PortDescriptor

pub fn is_input(&self) -> bool

pub fn is_output(&self) -> bool

Trait Implementations

impl Clone for PortDescriptor

fn clone(&self) -> PortDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PortDescriptor

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

Formats the value using the given formatter.

impl<T: Message> From<&InputPort<T>> for PortDescriptor

fn from(port: &InputPort<T>) -> Self

Converts to this type from the input type.

impl<T: Message> From<&OutputPort<T>> for PortDescriptor

fn from(port: &OutputPort<T>) -> Self

Converts to this type from the input type.

impl Hash for PortDescriptor

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 MaybeLabeled for PortDescriptor

fn label(&self) -> Option<Cow<'_, str>>

Returns the human-readable label, if any, of the object.

fn is_labeled(&self) -> bool

Checks whether the object has a human-readable label.

impl MaybeNamed for PortDescriptor

fn name(&self) -> Option<Cow<'_, str>>

Returns the name, if any, of the object.

fn is_named(&self) -> bool

Checks whether the object has a name.

impl Ord for PortDescriptor

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

Restrict a value to a certain interval.

impl PartialEq for PortDescriptor

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

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

fn id(&self) -> PortID

A unique identifier for this port.

fn state(&self) -> PortState

The current state of this port.

fn is_closed(&self) -> bool

Checks whether this port is currently closed.

fn is_open(&self) -> bool

Checks whether this port is currently open.

fn is_connected(&self) -> bool

Checks whether this port is currently connected.

fn close(&mut self) -> PortResult<bool>

Closes this port, returning immediately.

impl Serialize for PortDescriptor

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 PortDescriptor

impl StructuralPartialEq for PortDescriptor