Struct WatchedCore 

pub struct WatchedCore<'ctx, T: ?Sized, O: ?Sized = DefaultOwner> { /* private fields */ }

This represents some value which will be interesting to watch. Watcher functions that reference this value will be re-run when this value changes.

Implementations

impl<'ctx, T, O: ?Sized> WatchedCore<'ctx, T, O>

pub fn new(value: T) -> Self

Create a new watched value.

pub fn into_inner(self) -> T

Consumes the WatchedCore, returning the wrapped value

pub fn replace(&mut self, value: T, ctx: WatchArg<'_, 'ctx, O>) -> T

Takes the wrapped value, with a new one, returning the old value, without deinitializing either one, and notifies watchers that the value has changed.

pub fn replace_external(&mut self, value: T) -> T

pub fn take(&mut self, ctx: WatchArg<'_, 'ctx, O>) -> T

where T: Default,

Takes the wrapped value, leaving Default::default() in its place, and notifies watchers that the value has changed.

pub fn take_external(&mut self) -> T

where T: Default,

pub fn set_if_neq(&mut self, value: T, ctx: WatchArg<'_, 'ctx, O>)

where T: PartialEq,

This function provides a way to set a value for a watched value only if is has changed. This is useful for cases where setting a value would otherwise cause an infinite loop.

pub fn set_if_neq_external(&mut self, value: T)

where T: PartialEq,

impl<'ctx, T: ?Sized, O: ?Sized> WatchedCore<'ctx, T, O>

pub fn get(&self, ctx: WatchArg<'_, 'ctx, O>) -> &T

Get a referenced to the wrapped value, binding a watch closure.

pub fn get_mut(&mut self, ctx: WatchArg<'_, 'ctx, O>) -> &mut T

Get a mutable referenced to the wrapped value, notifying watchers that the value has changed.

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

pub fn get_unwatched(&self) -> &T

Get a referenced to the wrapped value, without binding any watch closure.

impl<T: ?Sized> WatchedCore<'static, T, DefaultOwner>

pub fn get_auto(&self) -> &T

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

pub fn replace_auto(&mut self, value: T) -> T

where T: Sized,

pub fn take_auto(&mut self) -> T

where T: Default,

pub fn set_if_neq_auto(&mut self, value: T)

where T: PartialEq + Sized,

This function provides a way to set a value for a watched value only if is has changed. This is useful for cases where setting a value would otherwise cause an infinite loop.

Trait Implementations

impl<'ctx, T: Default, O: ?Sized> Default for WatchedCore<'ctx, T, O>

fn default() -> Self

Returns the “default value” for a type.

impl<'ctx, T, O: ?Sized> From<T> for WatchedCore<'ctx, T, O>

fn from(value: T) -> Self

Converts to this type from the input type.

impl<'a, 'ctx, O, T> WatchedValueCore<'ctx, O> for &'a WatchedCore<'ctx, T, O>

where O: ?Sized, T: ?Sized,

type Value = &'a T

fn get(self, ctx: WatchArg<'_, 'ctx, O>) -> Self::Value

fn get_unwatched(self) -> Self::Value

fn map<F, U>(self, map_fn: F) -> impl WatchedValueCore<'ctx, O, Value = U>

where Self: Sized, F: FnOnce(Self::Value) -> U,