Struct FromStreamOptions 

pub struct FromStreamOptions {
    pub chunk_size: NumBytes,
    pub channel_capacity: usize,
}

NOTE: The maximum possible memory consumption is: chunk_size * channel_capacity. Although reaching that level requires:

1. A receiver to listen for chunks.
2. The channel getting full.

Fields

chunk_size: NumBytes

The size of an individual chunk read from the read buffer in bytes.

Must be greater than zero.

default: 16 * 1024 // 16 kb

channel_capacity: usize

The number of chunks held by the underlying async channel.

When the subscriber (if present) is not fast enough to consume chunks equally fast or faster than them getting read, this acts as a buffer to hold not-yet processed messages. The bigger, the better, in terms of system resilience to write-spikes. Multiply with chunk_size to obtain the amount of system resources this will consume at max.

Trait Implementations

impl Clone for FromStreamOptions

fn clone(&self) -> FromStreamOptions

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FromStreamOptions

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

Formats the value using the given formatter.

impl Default for FromStreamOptions

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq for FromStreamOptions

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

impl Eq for FromStreamOptions

impl StructuralPartialEq for FromStreamOptions