Skip to main content

Overflow

Enum Overflow 

Source
#[non_exhaustive]
pub enum Overflow { Block, DropTail, ResetStream { code: u64, }, }
Expand description

What happens when a per-stream queue is full.

#[non_exhaustive], with Block as the Default: the only non-destructive answer is the one a caller gets without asking.

There is deliberately no DropHead. Dropping an already queued unit happens after the framer’s positional cursor has moved past it, so the elide fix-up can no longer be armed — and on drafts 14-19 object IDs are delta-encoded, so the result is not a gap but every successor decoding with a wrong absolute ID. Overflow::DropTail is sound for exactly the reason DropHead is not: it discards the arriving unit, at admission time, where the fix-up is still legal.

Written as "block", "drop-tail" or {"reset-stream": {"code": 1}}.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

Block

Stop reading the source. Non-destructive. Default.

Per stream, and it does not reliably stall the peer: the transport’s own receive window absorbs megabytes first.

§

DropTail

Discard the arriving unit. Renumbers via the framer’s own elide fix-up, so absolute object IDs stay correct on drafts 14-19.

When an elide guard refuses the fix-up the unit is admitted anyway — the queue overshoots by one — and the refusal is reported. A shaper may not corrupt a stream to honour a depth limit.

§

ResetStream

Abandon the destination stream.

Fields

§code: u64

The application error code to reset with.

Trait Implementations§

Source§

impl Clone for Overflow

Source§

fn clone(&self) -> Overflow

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for Overflow

Source§

impl Debug for Overflow

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Overflow

Source§

fn default() -> Overflow

Returns the “default value” for a type. Read more
Source§

impl Eq for Overflow

Source§

impl PartialEq for Overflow

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for Overflow

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more