Struct SubscriptionName

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

Subscription names are used to identify streams that subscriptions read from. They are URI shaped, and must be valid URI strings.

Implementations

impl SubscriptionName

pub fn new(name: impl AsRef<str>) -> Self

Create a new subscription name, bypassing the URI check.

pub fn parse_string(candiate: impl AsRef<str>) -> Result<Self, String>

Parse a string into a subscription name. This will return an error if the string is not a valid URI.

Trait Implementations

impl AsRef<str> for SubscriptionName

fn as_ref(&self) -> &str

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

impl Clone for SubscriptionName

fn clone(&self) -> SubscriptionName

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubscriptionName

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

Formats the value using the given formatter.

impl Display for SubscriptionName

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

Formats the value using the given formatter.

impl FromStr for SubscriptionName

type Err = String

The associated error which can be returned from parsing.

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

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

impl SubscriptionTopic for SubscriptionName

fn stream_name(&self) -> SubscriptionName

Get the name of the stream that the subscription will read from.