Struct BufferConfig 

pub struct BufferConfig { /* private fields */ }

The configuration for the network buffers

Implementations

impl BufferConfig

pub fn from_config(config: &Config) -> BufferConfig

Tries to deserialise a configuration instance from the specified in the given config.

Returns the same values as BufferConfig::default if it fails to read from the config.

pub fn from_config_file<P>(path: P) -> BufferConfig

where P: Into<PathBuf>,

Tries to deserialise a BufferConfig from a TOML file at path

Returns the same values as BufferConfig::default if it fails to read from the config.

Panics

Panics if it fails to load the file or fails to load the file as TOML.

pub fn chunk_size(&mut self, size: usize)

Sets the chunk_size to the given number of bytes.

Specifies the size in bytes of each BufferChunk instance produced by pools using this configuration.

Must be at least 128 bytes, and must also be greater than encode_buf_min_free_space.

pub fn chunk_size_bytes(&self) -> usize

Returns the configured chunk size in bytes.

pub fn initial_chunk_count(&mut self, count: usize)

Sets the initial_chunk_count to the given number.

Specifies the number of BufferChunk instances that pools using this configuration create initially.

May be at most the value of max_chunk_count.

pub fn max_chunk_count(&mut self, count: usize)

Sets the max_chunk_count to the given number.

Specifies the maximum number of BufferChunk instances that pools using this configuration may create.

Must be at least the value of initial_chunk_count.

pub fn encode_buf_min_free_space(&mut self, size: usize)

Sets the encode_buf_min_free_space to the given number of bytes.

This sets the minimum number of bytes an EncodeBuffer must have available before attempting any serialisation into it.

Must be less than chunk_size.

pub fn validate(&self)

Performs basic sanity checks on the config parameters and panics if it is invalid.

This method is called automatically by any BufferPool on creation.

Trait Implementations

impl Clone for BufferConfig

fn clone(&self) -> BufferConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BufferConfig

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

Formats the value using the given formatter.

impl Default for BufferConfig

fn default() -> BufferConfig

Create a new configuration with default values which may then be overwritten

• chunk_size default value is 128 000.
• initial_chunk_count default value is 2.
• max_chunk_count default value is 1 000.
• encode_buf_min_free_space is 64.

impl PartialEq for BufferConfig

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

impl StructuralPartialEq for BufferConfig