Trait freya::prelude::Writable

pub trait Writable: Readable {
    type Mut<'a, R: 'static + ?Sized>: DerefMut<Target = R>;

Show 13 methods // Required methods fn map_mut<I, U, F>(ref_: Self::Mut<'_, I>, f: F) -> Self::Mut<'_, U> where F: FnOnce(&mut I) -> &mut U, I: ?Sized, U: ?Sized; fn try_map_mut<I, U, F>( ref_: Self::Mut<'_, I>, f: F ) -> Option<Self::Mut<'_, U>> where F: FnOnce(&mut I) -> Option<&mut U>, I: ?Sized, U: ?Sized; fn downcast_lifetime_mut<'a, 'b, T>( mut_: Self::Mut<'a, T> ) -> Self::Mut<'b, T> where 'a: 'b, T: 'static + ?Sized; fn try_write_unchecked( &self ) -> Result<Self::Mut<'static, Self::Target>, BorrowMutError>; // Provided methods fn write(&mut self) -> Self::Mut<'_, Self::Target> { ... } fn try_write( &mut self ) -> Result<Self::Mut<'_, Self::Target>, BorrowMutError> { ... } fn write_unchecked(&self) -> Self::Mut<'static, Self::Target> { ... } fn with_mut<O>(&mut self, f: impl FnOnce(&mut Self::Target) -> O) -> O { ... } fn set(&mut self, value: Self::Target) where Self::Target: Sized { ... } fn toggle(&mut self) where Self::Target: Not<Output = Self::Target> + Clone { ... } fn index_mut<I>( &mut self, index: I ) -> Self::Mut<'_, <Self::Target as Index<I>>::Output> where Self::Target: IndexMut<I> { ... } fn take(&mut self) -> Self::Target where Self::Target: Default { ... } fn replace(&mut self, value: Self::Target) -> Self::Target where Self::Target: Sized { ... }
}
Expand description

A trait for states that can be read from like crate::Signal, or crate::GlobalSignal. You may choose to accept this trait as a parameter instead of the concrete type to allow for more flexibility in your API. For example, instead of creating two functions, one that accepts a crate::Signal and one that accepts a crate::GlobalSignal, you can create one function that accepts a Writable type.

Required Associated Types§

type Mut<'a, R: 'static + ?Sized>: DerefMut<Target = R>

The type of the reference.

Required Methods§

fn map_mut<I, U, F>(ref_: Self::Mut<'_, I>, f: F) -> Self::Mut<'_, U>
where F: FnOnce(&mut I) -> &mut U, I: ?Sized, U: ?Sized,

Map the reference to a new type.

fn try_map_mut<I, U, F>( ref_: Self::Mut<'_, I>, f: F ) -> Option<Self::Mut<'_, U>>
where F: FnOnce(&mut I) -> Option<&mut U>, I: ?Sized, U: ?Sized,

Try to map the reference to a new type.

fn downcast_lifetime_mut<'a, 'b, T>(mut_: Self::Mut<'a, T>) -> Self::Mut<'b, T>
where 'a: 'b, T: 'static + ?Sized,

Downcast a mutable reference in a RefMut to a more specific lifetime

This function enforces the variance of the lifetime parameter 'a in Ref.

fn try_write_unchecked( &self ) -> Result<Self::Mut<'static, Self::Target>, BorrowMutError>

Try to get a mutable reference to the value without checking the lifetime. This will update any subscribers.

NOTE: This method is completely safe because borrow checking is done at runtime.

Provided Methods§

fn write(&mut self) -> Self::Mut<'_, Self::Target>

Get a mutable reference to the value. If the value has been dropped, this will panic.

fn try_write(&mut self) -> Result<Self::Mut<'_, Self::Target>, BorrowMutError>

Try to get a mutable reference to the value.

fn write_unchecked(&self) -> Self::Mut<'static, Self::Target>

Get a mutable reference to the value without checking the lifetime. This will update any subscribers.

NOTE: This method is completely safe because borrow checking is done at runtime.

fn with_mut<O>(&mut self, f: impl FnOnce(&mut Self::Target) -> O) -> O

Run a function with a mutable reference to the value. If the value has been dropped, this will panic.

fn set(&mut self, value: Self::Target)
where Self::Target: Sized,

Set the value of the signal. This will trigger an update on all subscribers.

fn toggle(&mut self)
where Self::Target: Not<Output = Self::Target> + Clone,

Invert the boolean value of the signal. This will trigger an update on all subscribers.

fn index_mut<I>( &mut self, index: I ) -> Self::Mut<'_, <Self::Target as Index<I>>::Output>
where Self::Target: IndexMut<I>,

Index into the inner value and return a reference to the result.

fn take(&mut self) -> Self::Target
where Self::Target: Default,

Takes the value out of the Signal, leaving a Default in its place.

fn replace(&mut self, value: Self::Target) -> Self::Target
where Self::Target: Sized,

Replace the value in the Signal, returning the old value.

Object Safety§

This trait is not object safe.

Implementors§

§

impl<T> Writable for GlobalSignal<T>
where T: 'static,

§

type Mut<'a, R: 'static + ?Sized> = Write<'a, R>

§

impl<T, S> Writable for CopyValue<T, S>
where T: 'static, S: Storage<T>,

§

type Mut<'a, R: 'static + ?Sized> = <S as AnyStorage>::Mut<'a, R>

§

impl<T, S> Writable for Signal<T, S>
where T: 'static, S: Storage<SignalData<T>>,

§

type Mut<'a, R: 'static + ?Sized> = Write<'a, R, S>