Struct s2n_quic_core::stream::ops::rx::Request

pub struct Request<'a> {
    pub chunks: Option<&'a mut [Bytes]>,
    pub low_watermark: usize,
    pub high_watermark: usize,
    pub stop_sending: Option<Error>,
    pub detached: bool,
}

A request on a rx stream

Fields

chunks: Option<&'a mut [Bytes]>

Optionally receive chunks from the stream

At least one of the provided chunks should be empty, as it will be replaced by the received data from the stream. The response will indicate how many chunks and bytes were consumed from the stream into the provided slice.

low_watermark: usize

Sets the low watermark for the rx stream

If the watermark is set to 0, the caller will be notified as soon as there is data available on the stream.

If the watermark is greater than 0, the caller will be notified as soon as there is at least low bytes available to be read. Note that the stream may be woken earlier.

high_watermark: usize

Sets the high watermark for the rx stream

The stream ensures that all the received data will not exceed the watermark amount. This can be useful for receiving at most n bytes.

stop_sending: Option<Error>

Optionally requests the peer to stop sending data with an error

detached: bool

Marks the rx stream as detached, which makes the stream make progress, regardless of application observations.

Trait Implementations

impl<'a> Debug for Request<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Request<'a>

fn default() -> Self

Returns the “default value” for a type.