Enum BackpressureSignal 

pub enum BackpressureSignal {
    Ready,
    Pause,
}

Backpressure signal from a consumer to the runtime.

Maps directly to the WIT backpressure-signal enum defined in torvyn:streaming@0.1.0 (Doc 01, Section 3.1).

Examples

use torvyn_types::BackpressureSignal;

let signal = BackpressureSignal::Pause;
assert!(signal.is_paused());

Variants

Ready

Consumer is ready to accept more data. Normal operation.

Pause

Consumer requests the producer to pause until further notice.

Implementations

impl BackpressureSignal

pub const fn is_paused(&self) -> bool

Returns true if the consumer is requesting a pause.

HOT PATH — called per element after sink invocation.

Trait Implementations

impl Clone for BackpressureSignal

fn clone(&self) -> BackpressureSignal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BackpressureSignal

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for BackpressureSignal

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for BackpressureSignal

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

Formats the value using the given formatter.

impl Hash for BackpressureSignal

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 BackpressureSignal

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Serialize for BackpressureSignal

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for BackpressureSignal

impl Eq for BackpressureSignal

impl StructuralPartialEq for BackpressureSignal