Enum spirit_log::background::OverflowMode

#[non_exhaustive]pub enum OverflowMode {
    Block,
    DropMsg,
    DropMsgSilently,
    AdaptiveDrop {
        from_level: Level,
        fill_limit: usize,
    },
}

Selection of how to act if the channel to the logger thread is full.

This enum is non-exhaustive. Adding more variants in the future will not be considered a breaking change.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Block

Blocks until there's enough space to push the message.

DropMsg

If there's not enough space in the channel, the message is dropped and counted.

Subsequently, the thread will log how many messages were lost.

DropMsgSilently

Drop the messages that don't without any indication it happened.

AdaptiveDrop

Drop less severe messages sooner than filling the whole buffer.

If the buffer is completely full, it acts like the DropMsg. If it's not full, but has more than fill_limit messages in it, messages with severity from_level or less severe are dropped, while more severe are still inserted into the buffer.

Both limits are inclusive.

Fields of AdaptiveDrop

from_level: Level

Level of severity of messages to drop if the buffer is more full that from_level.

fill_limit: usize

The level at which the less severe messages start being dropped.

Trait Implementations

impl Clone for OverflowMode

fn clone(&self) -> OverflowMode

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for OverflowMode

impl Debug for OverflowMode

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

Formats the value using the given formatter.

impl Eq for OverflowMode

impl Hash for OverflowMode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Ord for OverflowMode

fn cmp(&self, other: &OverflowMode) -> Ordering

This method returns an Ordering between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl PartialEq<OverflowMode> for OverflowMode

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

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

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

This method tests for !=.

impl PartialOrd<OverflowMode> for OverflowMode

fn partial_cmp(&self, other: &OverflowMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &OverflowMode) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &OverflowMode) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &OverflowMode) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &OverflowMode) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl StructuralEq for OverflowMode

impl StructuralPartialEq for OverflowMode