Struct MessageEndpoint 

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

The endpoint event’s data, parsed once and used verbatim.

A newtype over the whole target rather than a decomposed (path, query, session). Decomposing is the mistake: it makes the client’s next move “rebuild the URL”, and rebuilding is where a server’s choice of encoding becomes this client’s bug.

Implementations

impl MessageEndpoint

pub fn as_str(&self) -> &str

The target, exactly as the server wrote it.

pub fn path(&self) -> &str

The target’s path, without any query.

For a server logging what it offered, and for a test asserting the shape. A client has no use for this: it POSTs to as_str.

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

The query string, without the ?.

pub fn bare_path(value: &str) -> Result<Self, MessageEndpointError>

A path with no query and no fragment, for a server that will append one.

Distinct from FromStr because a configured path and an advertised endpoint are different shapes, and only one of them may carry a query. A path of /messages?tenant=a parses fine as a target — a client could be told to post there — but a server that then appends sessionId to it produces /messages?tenant=a?sessionId=1, whose second ? is data rather than a delimiter, and a client that splits on it gets a query of a?sessionId=1 and posts with no session at all. A # is worse: it makes the whole query a fragment, which the client drops silently.

Refusing both here is what lets with_query_parameter be infallible.

Errors

MessageEndpointError::NotAbsolutePath for an empty value, a non-/-initial one, one that is a query string, or one that names a scheme; MessageEndpointError::IllegalCharacter for a C0 control, DEL, or a space; and MessageEndpointError::QueryOrFragment for a value that already carries a ? or a #.

pub fn with_query_parameter(&self, key: &str, value: &str) -> Self

This target with one more query parameter appended.

Infallible, and that is the whole point: the result is a string this module assembled from a bare_path it already validated and a key and value it is choosing, so there is nothing left to parse and no way for the result to be one FromStr would refuse.

An existing query is preserved rather than replaced — ?tenant=a plus sessionId=1 is ?tenant=a&sessionId=1 — because the alternative is a server that silently discards its own configuration the first time a client is added.

key and value are not validated here, and cannot be: the only callers in this crate pass a &'static str constant and a hexadecimal session id. A caller with an arbitrary string should parse it into a MessageEndpoint instead of reaching for this.

Trait Implementations

impl Clone for MessageEndpoint

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 MessageEndpoint

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

Formats the value using the given formatter.

impl Display for MessageEndpoint

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

Formats the value using the given formatter.

impl Eq for MessageEndpoint

impl FromStr for MessageEndpoint

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

Parses a target the client can safely resolve against the origin it already dialled.

Errors

• MessageEndpointError::Empty for an empty target or a bare ?.
• MessageEndpointError::ProtocolRelative for a // prefix, which carries no scheme and so escapes a check that only looks for one.
• MessageEndpointError::Absolute for anything with a scheme. The check is on the scheme syntax, not on the literal ://, so mailto:x and data:text/plain,x are caught as well as https://host/.
• MessageEndpointError::IllegalCharacter for a C0 control, DEL, or a space.
• MessageEndpointError::NotAbsolutePath for a target that is neither empty nor /-initial: a relative messages?sessionId=x is ambiguous against whatever the client’s current path happens to be, and resolving it the way a browser would is not a behaviour a protocol should depend on.

type Err = MessageEndpointError

The associated error which can be returned from parsing.

impl Hash for MessageEndpoint

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 MessageEndpoint

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 MessageEndpoint

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for MessageEndpoint

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 MessageEndpoint