Enum iroh_blobs::protocol::Closed

#[repr(u16)]
pub enum Closed {
    StreamDropped = 0,
    ProviderTerminating = 1,
    RequestReceived = 2,
}

Reasons to close connections or stop streams.

A QUIC connection can be closed and a stream can request the other side to stop sending data. Both closing and stopping have an associated error_code, closing also adds a reason as some arbitrary bytes.

This enum exists so we have a single namespace for error_codes used.

Variants

StreamDropped = 0

The RecvStream was dropped.

Used implicitly when a RecvStream is dropped without explicit call to RecvStream::stop. We don’t use this explicitly but this is here as documentation as to what happened to 0.

ProviderTerminating = 1

The provider is terminating.

When a provider terminates all connections and associated streams are closed.

RequestReceived = 2

The provider has received the request.

Only a single request is allowed on a stream, if more data is received after this a provider may send this error code in a STOP_STREAM frame.

Implementations

impl Closed

pub fn reason(&self) -> &'static [u8]

The close reason as bytes. This is a valid utf8 string describing the reason.

Trait Implementations

impl Clone for Closed

fn clone(&self) -> Closed

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Closed

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

Formats the value using the given formatter.

impl From<Closed> for VarInt

fn from(source: Closed) -> Self

Converts to this type from the input type.

impl Hash for Closed

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 PartialEq for Closed

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<VarInt> for Closed

type Error = UnknownErrorCode

The type returned in the event of a conversion error.

fn try_from(value: VarInt) -> Result<Self, Self::Error>

Performs the conversion.

impl Copy for Closed

impl Eq for Closed

impl StructuralPartialEq for Closed