pub enum MaxBufferBehaviour {
    ResetStream,
    Block,
}
Expand description

Behaviour when the maximum length of the buffer is reached.

Variants§

§

ResetStream

Reset the substream whose frame buffer overflowed.

Note: If more than MplexConfig::set_max_buffer_size() frames are received in succession for a substream in the context of trying to read data from a different substream, the former substream may be reset before application code had a chance to read from the buffer. The max. buffer size needs to be sized appropriately when using this option to balance maximum resource usage and the probability of premature termination of a substream.

§

Block

No new message can be read from the underlying connection from any substream as long as the buffer for a single substream is full, i.e. application code is expected to read from the full buffer.

Note: To avoid blocking without making progress, application tasks should ensure that, when woken, always try to read (i.e. make progress) from every substream on which data is expected. This is imperative in general, as a woken task never knows for which substream it has been woken, but failure to do so with MaxBufferBehaviour::Block in particular may lead to stalled execution or spinning of a task without progress.

Trait Implementations§

Returns a copy of the value. Read more
Performs copy-assignment from source. Read more
Formats the value using the given formatter. Read more
This method tests for self and other values to be equal, and is used by ==. Read more
This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason. Read more

Auto Trait Implementations§

Blanket Implementations§

Gets the TypeId of self. Read more
Immutably borrows from an owned value. Read more
Mutably borrows from an owned value. Read more

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Should always be Self
The resulting type after obtaining ownership.
Creates owned data from borrowed data, usually by cloning. Read more
Uses borrowed data to replace owned data, usually by cloning. Read more
The type returned in the event of a conversion error.
Performs the conversion.
The type returned in the event of a conversion error.
Performs the conversion.