Struct event_feed::Feed

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

An event feed — the source of events in a feed-based event system.

Feeds are the source of readers, which are subscibers of the feed, capable of recieving the events from the feed.

Implementations

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

pub fn new() -> Self

Creates a new feed without any readers.

If you expect a certain number of readers, use with_reader_capacity.

pub fn with_reader_capacity(capacity: usize) -> Self

Creates a new feed with internal storage allocated to be able to send to the specified amount of readers without reallocation.

If you know in advance how many readers you will have, use this method. Otherwise, use new for simplicity.

pub fn add_reader(&mut self) -> Arc<Reader<Evt>>

Adds a new reader to the feed and returns it.

The resulting structure can be freely sent and shared over threads.

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

Sends an event to each reader by calling the specified closure once for each event.

If your type implements Clone, simply using send would be more idiomatic.

pub fn remove_dangling_readers(&mut self)

Removes references to dropped readers in order to release memory allocated for them and speed up calls to methods which send events.

impl<Evt> Feed<Evt> where
    Evt: Send + Clone, 

pub fn send(&self, event: Evt)

Sends the specified event to each reader by cloning it.

impl<Evt> Feed<Evt> where
    Evt: Send + Default, 

pub fn send_default(&self)

Sends the default value of the event.

The Default implementation for the event type is called once per reader, even if it implements Clone.

Trait Implementations

impl<Evt> Clone for Feed<Evt> where
    Evt: Send, 

fn clone(&self) -> Self

Clones the feed by creating a new feed which sends events to the same readers. The two feeds exist independently, i.e. adding a new reader to one of them will not modify another.

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

Performs copy-assignment from source.

impl<Evt: Debug> Debug for Feed<Evt> where
    Evt: Send, 

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

Formats the value using the given formatter.

impl<Evt> Default for Feed<Evt> where
    Evt: Send, 

fn default() -> Self

Returns the "default value" for a type.