Enum streamcatcher::Finaliser

pub enum Finaliser {
    InPlace,
    NewThread,
    AsyncStd,
    Tokio,
    Smol,
}

Method to allocate a new contiguous backing store, if required by Config::use_backing.

Choosing the incorrect async runtime may cause a panic, and any values other than InPlace or NewThread will result in an error in a synchronous Catcher.

Variants

InPlace

Allocate the new store and copy in all bytes in-place, blocking the current thread.

NewThread

Allocate the new store and copy in all bytes in-place in a new thread.

Default, safe to call in an async context.

AsyncStd

Use the async-std runtime for backing-store creation.

Requires the "async-std-compat" feature.

Tokio

Use the tokio runtime for backing-store creation.

Requires the "tokio-compat" feature.

Smol

Use the smol runtime for backing-store creation.

Requires the "smol-compat" feature.

Implementations

impl Finaliser

pub fn is_sync(&self) -> bool

Returns whether this option will block a reading thread in a sync-friendly manner.

pub fn run_elsewhere(&self) -> bool

Returns whether this option will block a reading thread to finalise.

Trait Implementations

impl Clone for Finaliser

fn clone(&self) -> Finaliser

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Finaliser

impl Debug for Finaliser

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

Formats the value using the given formatter.

impl Eq for Finaliser

impl PartialEq<Finaliser> for Finaliser

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

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

#[must_use]fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl StructuralEq for Finaliser

impl StructuralPartialEq for Finaliser