Struct Config

Source
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,
}
Expand description

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§

Source§

impl Config

Source

pub fn new() -> Self

Source

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.

Source

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.

Source

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.

Source

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.

Source

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.

Source

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

Convert this configuration into a standard Catcher.

Source

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§

Source§

impl Clone for Config

Source§

fn clone(&self) -> Config

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Config

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for Config

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl PartialEq for Config

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Copy for Config

Source§

impl Eq for Config

Source§

impl StructuralPartialEq for Config

Auto Trait Implementations§

§

impl Freeze for Config

§

impl RefUnwindSafe for Config

§

impl Send for Config

§

impl Sync for Config

§

impl Unpin for Config

§

impl UnwindSafe for Config

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> CompatExt for T

Source§

fn compat(self) -> Compat<T>

Applies the Compat adapter by value. Read more
Source§

fn compat_ref(&self) -> Compat<&T>

Applies the Compat adapter by shared reference. Read more
Source§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the Compat adapter by mutable reference. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more