Enum StreamCancelCode 

#[non_exhaustive]
pub enum StreamCancelCode {
    UnknownStream,
    InvalidSubscription,
    Forbidden,
    LimitExceeded,
    UserCancelled,
}

A machine-readable cancellation code for an event stream subscription.

Custom error codes should use the Java package naming convention.

This type can hold an arbitrary string. To build this with a custom value, convert it from a string with ::from() / .into(). To check for values that are not available as a documented variant here, use its string representation, obtained through .as_str().

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

UnknownStream

The publisher has no active stream for the requested descriptor, or the descriptor has expired.

InvalidSubscription

The subscription request is malformed or names an invalid subscriber device.

Forbidden

The subscriber is not allowed to receive updates.

LimitExceeded

The publisher has hit an implementation limit.

UserCancelled

The subscriber no longer wants updates.

Implementations

impl StreamCancelCode

pub fn as_str(&self) -> &str

Creates a string slice from this StreamCancelCode.

Trait Implementations

impl AsRef<str> for StreamCancelCode

fn as_ref(&self) -> &str

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

impl Clone for StreamCancelCode

fn clone(&self) -> StreamCancelCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StreamCancelCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StreamCancelCode

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for StreamCancelCode

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

Formats the value using the given formatter.

impl<T> From<T> for StreamCancelCode

where T: AsRef<str> + Into<Box<str>>,

fn from(s: T) -> Self

Converts to this type from the input type.

impl Ord for StreamCancelCode

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.

impl PartialEq for StreamCancelCode

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

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 Serialize for StreamCancelCode

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for StreamCancelCode