Struct Refusal 

#[non_exhaustive]
pub struct Refusal {
    pub code: String,
    pub message: String,
    pub detail: Option<Value>,
}

The body of an Error frame: a refusal of either operation, or the lagged or cancelled ending of a subscription.

code is one of codes (an unknown code is kept as received); message is for people and is not a stable interface. lagged and cursor_expired carry detail {"through": <cursor>}. Unknown members are ignored.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

code: String

message: String

detail: Option<Value>

Implementations

impl Refusal

pub fn new(code: impl Into<String>, message: impl Into<String>) -> Self

A refusal without detail.

pub fn lagged(through: impl Into<Cursor>, message: impl Into<String>) -> Self

The lagged ending: through is the last notified cursor.

pub fn cancelled(message: impl Into<String>) -> Self

The cancelled ending a provider may send after the caller’s own Cancel. A reader treats it, after its own Cancel, as the normal end.

pub fn cursor_expired( through: impl Into<Cursor>, message: impl Into<String>, ) -> Self

The cursor_expired refusal of a read: through is the newest cursor.

pub fn through(&self) -> Option<Cursor>

The cursor in detail.through, when the refusal carries one.

Trait Implementations

impl Clone for Refusal

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 Refusal

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Refusal

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Refusal

impl PartialEq for Refusal

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

Equality operator ==.

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

Inequality operator !=.

impl Serialize for Refusal

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Refusal