Struct PortName 

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

Shared name for plugs and sockets. The two kinds live in the same per-element namespace (SRD-0005 D13): an element may not have a plug and a socket with the same PortName.

Implementations

impl PortName

pub fn new(candidate: impl Into<String>) -> Result<Self, NameError>

Construct a new $Name, validating the candidate.

pub fn as_str(&self) -> &str

Borrow the inner string.

pub fn into_inner(self) -> String

Consume the name and return the inner string.

Trait Implementations

impl AsRef<str> for PortName

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for PortName

fn clone(&self) -> PortName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PortName

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PortName

fn deserialize<D: Deserializer<'de>>(deserializer: D) -> Result<Self, D::Error>

Deserialize this value from the given Serde deserializer.

impl Display for PortName

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

Formats the value using the given formatter.

impl FromStr for PortName

type Err = NameError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, NameError>

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

impl Hash for PortName

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 Name for PortName

const KIND: &'static str = "PortName"

Human-readable kind label, used in error messages and Debug.

const MAX_LEN: usize = 64

Maximum byte length (UTF-8). Default 64 — override when a larger ceiling is natural (plan names, for example).

fn validate_char(offset: usize, ch: char) -> Result<(), NameError>

Called once per character to decide membership.

fn validate(s: &str) -> Result<(), NameError>

Validate the given string as a name of this kind.

impl Ord for PortName

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

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

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

fn serialize<S: Serializer>(&self, s: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for PortName

type Error = NameError

The type returned in the event of a conversion error.

fn try_from(s: &str) -> Result<Self, NameError>

Performs the conversion.

impl TryFrom<String> for PortName

type Error = NameError

The type returned in the event of a conversion error.

fn try_from(s: String) -> Result<Self, NameError>

Performs the conversion.

impl Eq for PortName

impl StructuralPartialEq for PortName