Skip to main content

Demand

Struct Demand 

Source
#[non_exhaustive]
pub struct Demand { pub want_bytes: usize, pub saturated: bool, }
Expand description

A stage’s hint about how much more input it can usefully accept right now.

This is advisory backpressure, not enforcement: a driver may call Stage::feed with more than want_bytes, or while saturated is true, and a well-behaved stage must still handle it correctly (buffering, erroring, or blocking as its own contract dictates) — Demand only lets a cooperative driver avoid doing so needlessly.

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§want_bytes: usize

How many more bytes this stage would like handed to Stage::feed before it is called again. 0 carries no meaning beyond “no particular preference”; it is not a demand for zero bytes.

§saturated: bool

true if the stage is currently full and would prefer not to receive more input until it has been polled / has had time to drain.

Implementations§

Source§

impl Demand

Source

pub const fn new(want_bytes: usize) -> Self

Build a Demand requesting want_bytes more input, not saturated.

Source

pub const fn saturated() -> Self

A Demand indicating the stage currently wants no more input.

Trait Implementations§

Source§

impl Clone for Demand

Source§

fn clone(&self) -> Demand

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 Demand

Source§

impl Debug for Demand

Source§

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

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

impl Default for Demand

Source§

fn default() -> Demand

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

impl Eq for Demand

Source§

impl PartialEq for Demand

Source§

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

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, 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 = Infallible

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.