Skip to main content

StreamError

Enum StreamError 

Source
#[non_exhaustive]
pub enum StreamError {
Show 18 variants Session(SessionError), Internal, Cancel, DeliveryTimeout, ControlTimeout, GoingAway, TooFarBehind, MalformedTrack, NotFound, Unroutable, Old, Evicted, WrongSize, FrameTooLarge, GroupTooLarge, TimestampMismatch, App(u16), Unknown(u32),
}
Expand description

A code sent when resetting a stream, or refusing to receive one.

The counterpart to SessionError, and a disjoint space: a stream reset of 0 is Internal, not a cancellation (Cancel is 1).

Conditions the shared codes don’t cover are assigned in moq-lite’s own 48-63 range and round-trip like any other registered code. 32 through 47 is reserved: nothing is sent there and a received one stays Unknown.

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.
§

Session(SessionError)

The session ended, taking this stream with it.

The specific SessionError is local only: the two registries are disjoint, so this encodes to a single SESSION_CLOSED and the peer learns the reason from the session close itself.

§

Internal

Something went wrong that isn’t worth a dedicated code.

§

Cancel

The sender is done with this stream, not failing. A routine unsubscribe.

§

DeliveryTimeout

The content missed its delivery deadline.

§

ControlTimeout

A control request took too long to be answered. The stream counterpart to SessionError::Timeout, which covers the same condition at session scope.

§

GoingAway

The session is going away (a GOAWAY was received).

§

TooFarBehind

The reader fell too far behind and content was dropped to catch up.

§

MalformedTrack

The track’s content could not be parsed.

§

NotFound

The requested broadcast or track does not exist at the peer.

§

Unroutable

The broadcast is neither announced nor served, so there is no route to it.

§

Old

The group was superseded by a newer group and dropped.

§

Evicted

The group was dropped under memory pressure. Unlike Old it was still current, so it can be re-fetched.

§

WrongSize

A frame’s payload length disagreed with its declared size.

§

FrameTooLarge

A frame declared a payload larger than the receiver accepts.

§

GroupTooLarge

A group grew past its cache budget and was aborted.

§

TimestampMismatch

A frame’s timestamp doesn’t match its track’s negotiated timescale.

§

App(u16)

An application-chosen code, offset into the 64+ range on the wire.

§

Unknown(u32)

A code this version does not recognize, kept verbatim.

Implementations§

Source§

impl StreamError

Source

pub fn to_code(&self) -> u32

The integer sent on the wire.

Source

pub fn from_code(code: u32) -> Self

Decode a code received off the wire.

Only the registered codes decode; anything else, the reserved 32-47 range included, stays Unknown rather than being given a meaning the draft does not assign.

SESSION_CLOSED decodes to Session(SessionError::Internal): the peer’s actual session code is not on this stream, so the specific reason is unknown here.

Trait Implementations§

Source§

impl Clone for StreamError

Source§

fn clone(&self) -> Self

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 Debug for StreamError

Source§

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

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

impl Display for StreamError

Source§

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

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

impl Eq for StreamError

Source§

impl Error for StreamError

Source§

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any. Read more
1.0.0 · Source§

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

1.0.0 · Source§

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Source§

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)
Provides type-based access to context intended for error reports. Read more
Source§

impl From<&Error> for StreamError

Which stream code to send for a local error.

Session-scoped conditions route through StreamError::Session, which flattens to SESSION_CLOSED on the wire.

Source§

fn from(err: &Error) -> Self

Converts to this type from the input type.
Source§

impl From<SessionError> for StreamError

Source§

fn from(source: SessionError) -> Self

Converts to this type from the input type.
Source§

impl From<StreamError> for Error

Preserve the stream registry when carrying a protocol error.

Source§

fn from(err: StreamError) -> Self

Converts to this type from the input type.
Source§

impl PartialEq for StreamError

Source§

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

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> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSend for T
where T: Send + ?Sized,

Source§

impl<T> MaybeSend for T
where T: Send,

Source§

impl<T> MaybeSync for T
where T: Sync,

Source§

impl<T> MaybeSync for T
where T: Sync,

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> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. 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, !>

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