Struct zenoh_flow_commons::PortId

pub struct PortId(/* private fields */);

A PortId identifies an Input or an Output of a Node.

A PortId additionally satisfies the following constraints:

• it does not contain any of the symbols: * # $ ? >
• it is a valid canonical Zenoh key expression.

Uniqueness

A PortId does not need to be unique within a data flow. It should only be unique among the ports of the same node and of the same type (i.e. Input or Output). For instance, a node can have an Input and an Output with the same PortId.

Performance

A PortId is encapsulated in an Arc rendering clone operations inexpensive.

Trait Implementations

impl Clone for PortId

fn clone(&self) -> PortId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for PortId

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

Formats the value using the given formatter.

impl Deref for PortId

type Target = Arc<str>

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for PortId

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for PortId

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

Formats the value using the given formatter.

impl From<&str> for PortId

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<String> for PortId

fn from(value: String) -> Self

Converts to this type from the input type.

impl Hash for PortId

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 PartialEq for PortId

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

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 PortId

impl StructuralPartialEq for PortId