Enum StreamEvent 

#[non_exhaustive]
pub enum StreamEvent {
    Opened {
        id: StreamId,
    },
    Readable {
        id: StreamId,
    },
    Writable {
        id: StreamId,
    },
    Finished {
        id: StreamId,
    },
    Stopped {
        id: StreamId,
        error_code: ErrorCauseCode,
    },
    Available,
    BufferedAmountLow {
        id: StreamId,
    },
    BufferedAmountHigh {
        id: StreamId,
    },
    BufferedAmountReleased {
        id: StreamId,
        n_bytes: usize,
    },
}

Application events about streams

Variants (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.

Opened

One or more new streams has been opened

Fields

id: StreamId

Which stream was opened.

Readable

A currently open stream has data or errors waiting to be read

Fields

id: StreamId

Which stream is now readable

Writable

A formerly write-blocked stream might be ready for a write or have been stopped

Only generated for streams that are currently open.

Fields

id: StreamId

Which stream is now writable

Finished

A finished stream has been fully acknowledged or stopped

Fields

id: StreamId

Which stream has been finished

Stopped

The peer asked us to stop sending on an outgoing stream

Fields

id: StreamId

Which stream has been stopped

error_code: ErrorCauseCode

Error code supplied by the peer

Available

At least one new stream of a certain directionality may be opened

BufferedAmountLow

The number of bytes of outgoing data buffered is lower than the threshold.

Fields

id: StreamId

Which stream is now readable

BufferedAmountHigh

The number of bytes of outgoing data buffered is higher than the threshold.

Fields

id: StreamId

Which stream is now readable

BufferedAmountReleased

Outgoing buffered data was released (acknowledged OR abandoned), carrying the exact number of user payload bytes freed for this stream. Unlike the edge-triggered StreamEvent::BufferedAmountLow, this fires on every release with the byte delta, so upper layers can keep their own send-buffer accounting (e.g. a synchronous back-pressure counter) exact.

Fields

id: StreamId

Which stream released buffered bytes

n_bytes: usize

User payload bytes released

Trait Implementations

impl Debug for StreamEvent

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

Formats the value using the given formatter.

impl Eq for StreamEvent

impl PartialEq for StreamEvent

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for StreamEvent