Struct RangeStatus 

pub struct RangeStatus(pub u32);

The answer to iris.require_range.

Only RangeStatus::SERVED means the bytes are in the buffer the decoder named. For every other value the buffer has not been written to and holds whatever it held before.

Tuple Fields

0: u32

Implementations

impl RangeStatus

pub const SERVED: Self

The bytes are in the buffer, all of them, exactly as many as were asked for.

pub const OUT_OF_BOUNDS: Self

The range runs past the end of the source.

The decoder asked for the wrong thing. This is never a short read, which is the whole reason it is a status rather than a returned length: a decoder that gets fewer bytes than it asked for and does not notice produces an answer that is wrong and looks right.

pub const TOO_LARGE: Self

No single request to this host can cover a range that long.

The host is reading through a window and the range does not fit in one view of it. Asking again in pieces works, which is what makes this different from the two below.

pub const UNAVAILABLE: Self

The host tried and could not get the bytes.

A read that failed, a connection that dropped, a source that contradicted itself. Nothing the decoder does differently will help, and the host already knows the details.

pub const NO_SOURCE: Self

This host has nothing to serve ranges from.

A decoder that pulls ranges was run by a host that handed it the whole source and did not expect to be asked, or by one that has not attached a source yet. It is a host bug rather than a decoder bug, and it is separate from RangeStatus::UNAVAILABLE because the fix is in a different place.

pub const fn is_served(self) -> bool

Whether the bytes arrived.

pub const fn name(self) -> Option<&'static str>

The name of this status, if it is one we assigned.

Trait Implementations

impl Clone for RangeStatus

fn clone(&self) -> RangeStatus

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RangeStatus

impl Debug for RangeStatus

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

Formats the value using the given formatter.

impl Display for RangeStatus

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

Formats the value using the given formatter.

impl Eq for RangeStatus

impl Hash for RangeStatus

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 Ord for RangeStatus

fn cmp(&self, other: &RangeStatus) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

🔬This is a nightly-only experimental API. (clamp_to)

Restrict a value to a certain range.

impl PartialEq for RangeStatus

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for RangeStatus

fn partial_cmp(&self, other: &RangeStatus) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralPartialEq for RangeStatus