Struct channel::diem_channel::Config

pub struct Config {
    pub queue_style: QueueStyle,
    pub max_capacity: usize,
    pub counters: Option<&'static IntCounterVec>,
}

Configuration for a new diem_channel queue.

Fields

queue_style: QueueStyle

max_capacity: usize

counters: Option<&'static IntCounterVec>

Implementations

impl Config

pub fn new(max_capacity: usize) -> Self

The diem_channel has a “sub-queue” per key. The max_capacity controls the capacity of each “sub-queue”; when the queues exceed the max capacity the messages will be dropped according to the queue style/eviction policy.

pub fn queue_style(self, queue_style: QueueStyle) -> Self

The queue’s push/pop and eviction behavior. Defaults to FIFO.

pub fn counters(self, counters: &'static IntCounterVec) -> Self

Optional prometheus counters for this queue, which keep track of items in the queue and # dropped items. Defaults to no counters.

pub fn build<K: Eq + Hash + Clone, M>(self) -> (Sender<K, M>, Receiver<K, M>)

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 Copy for Config