Struct PortUri 

pub struct PortUri {
    pub scheme: String,
    pub authority: String,
    pub path: Vec<String>,
    pub index: u32,
}

A structured URI identifying a single channel of a port.

Graph ports use the sim-node://graph/<graph-id>/<node-id>/<port-name>:<index> form; PortUri::node builds that shape and PortUri::node_id / PortUri::node_port_name read it back.

Fields

scheme: String

URI scheme (for example sim-node).

authority: String

URI authority (for example graph).

path: Vec<String>

Path segments after the authority.

index: u32

Channel index within the port.

Implementations

impl PortUri

pub fn new( scheme: impl Into<String>, authority: impl Into<String>, path: Vec<String>, index: u32, ) -> Result<Self>

Creates and validates a port URI from its parts.

pub fn node( graph_id: impl Into<String>, node_id: impl Into<String>, port_name: impl Into<String>, index: u32, ) -> Result<Self>

Builds a graph node port URI in the sim-node://graph/... form.

pub fn node_id(&self) -> Option<&str>

Returns the node id if this is a graph node port URI.

pub fn node_port_name(&self) -> Option<&str>

Returns the port name if this is a graph node port URI.

Trait Implementations

impl Clone for PortUri

fn clone(&self) -> PortUri

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PortUri

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

Formats the value using the given formatter.

impl Display for PortUri

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

Formats the value using the given formatter.

impl Eq for PortUri

impl FromStr for PortUri

type Err = Error

The associated error which can be returned from parsing.

fn from_str(text: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl Hash for PortUri

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 PortUri

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

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

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