Struct drying_paint::Watcher

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

Watcher is a structure designed to hold some data along with associated functions which will run when watched data changes.

Implementations

impl<T: WatcherInit> Watcher<T>

pub fn create(data: T) -> Self

Create a new Watcher. After creation, will run WatcherInit::init for the stored data. Watchers need to be created inside WatchContext::allow_watcher_access() in order to observe aliasing rules.

pub fn into_inner(self) -> T

Consume the Watcher and return the data stored inside. Watch callbacks will no longer run.

impl<T: WatcherInit + ?Sized> Watcher<T>

pub fn data(&self) -> &T

Get an immutable reference to the data stored in this Watcher. In order to ensure aliasing rules are maintained, this function will panic if called outside a watch callback or WatchContext::allow_watcher_access

pub fn data_mut(&mut self) -> &mut T

Get an mutable reference to the data stored in this Watcher. In order to ensure aliasing rules are maintained, this function will panic if called outside a watch callback or WatchContext::allow_watcher_access

impl<T: WatcherInit + Default> Watcher<T>

pub fn new() -> Self

Create a Watcher with default data. After creation, will run WatcherInit::init for the stored data.

impl<T: 'static> Watcher<T>

pub fn id(&self) -> WatcherId

Get a value representing a unique id for this watcher. This value may outlive the watcher, and will never compare equal to a value returned by the id method of a Watcher other than this one.

Trait Implementations

impl<T: WatcherInit + Clone> Clone for Watcher<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: WatcherInit + Default> Default for Watcher<T>

fn default() -> Self

Returns the "default value" for a type.