Struct Refusal 

pub struct Refusal<'a> {
    pub reason: RefusalReason,
    pub capability: Capability,
    pub detail: &'a str,
}

One side declining to go on, and saying why.

The reason a refusal is a record rather than a dropped connection is that “this did not work” is not an actionable message. Somebody has to be able to read the failure and know which capability to go and implement.

Fields

reason: RefusalReason

The category of problem.

capability: Capability

Which capability was missing, when reason is RefusalReason::MISSING_CAPABILITY.

detail: &'a str

Text for a human. Not parsed by anything.

Implementations

impl<'a> Refusal<'a>

pub const VERSION: u16 = 1

The layout version of this record.

pub const fn new(reason: RefusalReason, detail: &'a str) -> Self

A refusal with no particular capability attached.

pub fn encode(&self, w: &mut Writer<'_>) -> Result<()>

Writes the record.

Errors

Returns Error::BufferFull if the buffer runs out.

pub fn decode(version: u16, p: &mut Reader<'a>) -> Result<Self>

Reads the record from its payload.

Errors

Returns Error::UnsupportedVersion if the layout version is not one this build knows, Error::Truncated if the payload ends early, or Error::NotUtf8 if the detail is not text.

Trait Implementations

impl<'a> Clone for Refusal<'a>

fn clone(&self) -> Refusal<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Copy for Refusal<'a>

impl<'a> Debug for Refusal<'a>

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

Formats the value using the given formatter.

impl<'a> Eq for Refusal<'a>

impl<'a> PartialEq for Refusal<'a>

fn eq(&self, other: &Refusal<'a>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<'a> StructuralPartialEq for Refusal<'a>