Struct EventName 

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

A validated event: value.

A Cow rather than an Arc<str> for one reason that turned out to decide the design: Arc::from is not const, so an Arc-backed name cannot be a const, and the two names the legacy transport is defined by are exactly the kind of thing that should be a constant rather than a value built at first use. Cow::Borrowed is const-constructible, so the two names the specification names cost nothing and compare without a pointer chase, while a name that arrived from a peer is owned and costs one allocation — which is right, because a peer’s name is not known ahead of time and there is nothing to borrow it from.

Borrowed is safe here for the same reason it is safe anywhere: a &'static str has no lifetime to shorten, and from_str is the only constructor that produces a Borrowed variant.

Implementations

impl EventName

pub fn as_str(&self) -> &str

The name as a string.

pub fn is(&self, name: &Self) -> bool

Whether this is name.

Compares contents, not representations: a Borrowed("message") and an owned "message" are the same name, and a client that dispatched on which one it was would be matching on an implementation detail.

Trait Implementations

impl Clone for EventName

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventName

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

Formats the value using the given formatter.

impl Display for EventName

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

Formats the value using the given formatter.

impl Eq for EventName

impl FromStr for EventName

fn from_str(value: &str) -> Result<Self, Self::Err>

Parses a name, refusing the one thing that would inject a field.

CR and LF are both rejected, and both must be: the encoder’s line terminator is LF, but a conformant reader also treats a lone CR as a break, so a name holding a CR reads as two fields on a reader that the writer did not have in mind. Rejecting only LF would leave that reader injectable.

A colon is not rejected. The grammar makes the value the rest of the line, so a:b is a legal name and a client comparing it to b has a bug, not a server that corrupted it.

Errors

EventNameError::Empty for an empty value, and EventNameError::LineTerminator for one containing CR or LF.

type Err = EventNameError

The associated error which can be returned from parsing.

impl Hash for EventName

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 EventName

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,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for EventName

fn eq(&self, other: &Self) -> bool

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for EventName

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 StructuralPartialEq for EventName