Struct event_feed::Reader

pub struct Reader<Evt> where
    Evt: Send,  { /* fields omitted */ }

Recieves events from event feeds and queues them until they are processed.

Implementations

impl<Evt> Reader<Evt> where
    Evt: Send, 

pub fn read(&self) -> ReaderIter<Evt>

Creates an iterator which reads and removes the events from the queue.

The queue's mutex remains locked for the entire lifetime of the returned iterator, which means that all calls to the feed's send_with, send and others will block. If you do not want that behavior, drop the iterator after a number of iterations and create a new one, which should cause a fair mutex unlock if it ran for long enough, allowing the feed to send new events.

pub fn read_with<F>(&self, f: F) where
    F: FnMut(Evt), 

Reads the entire queue by using the specified closure to process the events. Useful for simple event handling, i.e. if the closure doesn't return anything depending on how it processes the events. If it does, using read directly is necesarry.

See read for the mutex-related implications of using this.

Trait Implementations

impl<Evt> Debug for Reader<Evt> where
    Evt: Debug + Send, 

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

Formats the value using the given formatter.

impl<'r, Evt> IntoIterator for &'r Reader<Evt> where
    Evt: Send, 

type IntoIter = ReaderIter<'r, Evt>

Which kind of iterator are we turning this into?

type Item = Evt

The type of the elements being iterated over.

fn into_iter(self) -> ReaderIter<'r, Evt>

Creates an iterator which reads and removes events from the queue.

Equivalent to self.read(), intended to be used in for loops.