Struct ObservableValue

Source
pub struct ObservableValue<T>
where T: Clone,
{ /* private fields */ }
Expand description

A value that implements the Observer pattern.

Consumers can connect to receive callbacks when the value changes.

Implementations§

Source§

impl<T> ObservableValue<T>
where T: Clone,

Source

pub fn new(initial_value: T) -> ObservableValue<T>

Construct an ObservableValue.

Source

pub fn get(&self) -> &T

Get the current value

Source

pub fn set(&mut self, new_value: &T)

Set a new value and notify all connected subscribers.

Source

pub fn connect<F>(&mut self, callback: F) -> SubscriptionId
where F: Fn(&T) + 'static,

Connect a new subscriber that will receive callbacks when the value is set.

Returns a SubscriptionId to disconnect the subscription when no longer required.

Source

pub fn disconnect(&mut self, sub_id: SubscriptionId)

Disconnect an existing subscription.

Source

pub fn split(self) -> (ReadHalf<T>, WriteHalf<T>)

Divide this instance into a read half (can listen for updates, but cannot write new values) and a write half (can write new values).

Auto Trait Implementations§

§

impl<T> Freeze for ObservableValue<T>
where T: Freeze,

§

impl<T> !RefUnwindSafe for ObservableValue<T>

§

impl<T> !Send for ObservableValue<T>

§

impl<T> !Sync for ObservableValue<T>

§

impl<T> Unpin for ObservableValue<T>
where T: Unpin,

§

impl<T> !UnwindSafe for ObservableValue<T>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.