Struct streamcatcher::Config

pub struct Config {
    pub chunk_size: GrowthStrategy,
    pub spawn_finaliser: Finaliser,
    pub use_backing: bool,
    pub length_hint: Option<usize>,
    pub read_burst_len: usize,
}

Options controlling backing store allocation, finalisation, and so on.

Fields

chunk_size: GrowthStrategy

spawn_finaliser: Finaliser

use_backing: bool

length_hint: Option<usize>

read_burst_len: usize

Implementations

impl Config

pub fn new() -> Self

pub fn chunk_size(self, size: GrowthStrategy) -> Self

The amount of bytes to allocate whenever more space is required to store the stream.

A larger value is generally preferred for minimising locking and allocations, but may reserve too much space before the struct is finalised.

Defaults to Constant(4096). Start be larger than the transform’s minimum chunk size.

pub fn use_backing(self, val: bool) -> Self

Allocate a single contiguous backing store to speed up reads after the stream ends.

Defaults to true.

pub fn spawn_finaliser(self, finaliser: Finaliser) -> Self

Spawn a new thread/task to move contents of the rope into backing storage once a stream completes.

Disabling this may negatively impact performance of the final read in a stream.

Defaults to Finaliser::NewThread.

pub fn length_hint(self, hint: Option<usize>) -> Self

Estimate for the amount of data required to store the completed stream.

On None, this will be set to chunk_size.

Defaults to None.

pub fn read_burst_len(self, burst: usize) -> Self

The minimum size of reads to attempt from the input stream, if possible.

Defaults to 4096.

pub fn build<T>(self, source: T) -> Result<Catcher<T>>

Convert this configuration into a standard Catcher.

pub fn build_tx<T, Tx: NeedsBytes>(
    self,
    source: T,
    transform: Tx
) -> Result<TxCatcher<T, Tx>>

Convert this configuration into a TxCatcher with a custom transform.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl PartialEq<Config> for Config

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Copy for Config

impl Eq for Config

impl StructuralEq for Config

impl StructuralPartialEq for Config