Struct revent::Single

pub struct Single<T: ?Sized> { /* fields omitted */ }

Single slot containing T.

A single is a container for a single Node. It ensures that a single node always exists, panicking if not present on access. In addition, no more than a single node may subscribe to this container at a time.

Methods

impl<T: ?Sized> Single<T>

pub fn new(name: &'static str, manager: &Manager) -> Self

Create a new single object.

The manager is used to organize multiple single/slot objects and to ensure that there are no recursive (double mutable borrow) signal chains.

name is used for error reporting and graph generation in Manager.

pub fn emit<F, R>(&mut self, caller: F) -> R where
    F: FnMut(&mut T) -> R, 

Emit a signal on this signal single.

Panics if no node is subscribed to this single.

pub fn register(&mut self, item: Rc<RefCell<T>>)

Add or remove a node object to this single.

The action taken depends on whether Anchor::subscribe or Anchor::unsubscribe was called.

Panics

Panics if called from Anchor::unsubscribe while not being registered.

Panics from a Anchor::subscribe context if an object is already registered with this Single.

Trait Implementations

impl<T: ?Sized> Clone for Single<T>

fn clone(&self) -> Self

Cloning is only valid from within an Anchor::subscribe context.

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

Performs copy-assignment from source.

impl<T: ?Sized> Debug for Single<T>

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

Formats the value using the given formatter.