Enum pharos::Channel

pub enum Channel {
    Bounded(usize),
    Unbounded,
    __NonExhaustive__,
}

Choose the type of channel that will be used for your event stream. Used in ObserveConfig.

Variants

Bounded(usize)

A channel with a limited buffer (the usize parameter). Creates back pressure when the buffer is full. This means that producer tasks may block if consumers can't process fast enough.

Unbounded

A channel with unbounded capacity. Note that this may lead to unbouded memory consumption if producers outpace consumers.

__NonExhaustive__

This enum might grow in the future, thanks to this that won't be a breaking change.

Trait Implementations

impl Eq for Channel

impl Default for Channel

fn default() -> Self

Returns the "default value" for a type.

impl Clone for Channel

fn clone(&self) -> Channel

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialOrd<Channel> for Channel

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

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

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

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

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

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

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

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

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

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

impl PartialEq<Channel> for Channel

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

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

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

This method tests for !=.

impl Ord for Channel

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

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl<Event> From<Channel> for ObserveConfig<Event> where
    Event: Clone + 'static + Send, 

Create a ObserveConfig from a Channel, getting default values for other options.

fn from(channel: Channel) -> Self

Performs the conversion.

impl Copy for Channel

impl Debug for Channel

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

Formats the value using the given formatter.