Struct freya::prelude::CopyValue

pub struct CopyValue<T, S = UnsyncStorage>
where
    T: 'static,
    S: Storage<T>,
{ /* private fields */ }

CopyValue is a wrapper around a value to make the value mutable and Copy.

It is internally backed by [generational_box::GenerationalBox].

Implementations

impl<T> CopyValue<T>

where T: 'static,

pub fn new(value: T) -> CopyValue<T>

Create a new CopyValue. The value will be stored in the current component.

Once the component this value is created in is dropped, the value will be dropped.

pub fn new_in_scope(value: T, scope: ScopeId) -> CopyValue<T>

Create a new CopyValue. The value will be stored in the given scope. When the specified scope is dropped, the value will be dropped.

impl<T, S> CopyValue<T, S>

where T: 'static, S: Storage<T>,

pub fn new_maybe_sync(value: T) -> CopyValue<T, S>

Create a new CopyValue. The value will be stored in the current component.

Once the component this value is created in is dropped, the value will be dropped.

pub fn new_maybe_sync_in_scope(value: T, scope: ScopeId) -> CopyValue<T, S>

Create a new CopyValue. The value will be stored in the given scope. When the specified scope is dropped, the value will be dropped.

pub fn new_maybe_sync_in_scope_with_caller( value: T, scope: ScopeId, caller: &'static Location<'static> ) -> CopyValue<T, S>

Create a new CopyValue with a custom caller. The value will be stored in the given scope. When the specified scope is dropped, the value will be dropped.

pub fn manually_drop(&self) -> Option<T>

Manually drop the value in the CopyValue, invalidating the value in the process.

pub fn origin_scope(&self) -> ScopeId

Get the scope this value was created in.

pub fn id(&self) -> GenerationalBoxId

Get the generational id of the value.

pub fn value(&self) -> GenerationalBox<T, S>

Get the underlying [GenerationalBox] value.

Trait Implementations

impl<T, S> Add<T> for CopyValue<T, S>

where T: Add<Output = T> + Copy + 'static, S: Storage<T>,

type Output = T

The resulting type after applying the + operator.

fn add(self, rhs: T) -> <CopyValue<T, S> as Add<T>>::Output

Performs the + operation.

impl<T, S> AddAssign<T> for CopyValue<T, S>

where T: Add<Output = T> + Copy + 'static, S: Storage<T>,

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl<T, S> Clone for CopyValue<T, S>

where S: Storage<T>,

fn clone(&self) -> CopyValue<T, S>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T, S> Debug for CopyValue<T, S>

where T: Debug + 'static, S: Storage<T>,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T, S> Default for CopyValue<T, S>

where T: Default + 'static, S: Storage<T>,

fn default() -> CopyValue<T, S>

Returns the “default value” for a type.

impl<T, S> Deref for CopyValue<T, S>

where T: Copy, S: Storage<T>,

type Target = dyn Fn() -> T

The resulting type after dereferencing.

fn deref(&self) -> &<CopyValue<T, S> as Deref>::Target

Dereferences the value.

impl<T, S> Display for CopyValue<T, S>

where T: Display + 'static, S: Storage<T>,

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<T, S> Div<T> for CopyValue<T, S>

where T: Div<Output = T> + Copy + 'static, S: Storage<T>,

type Output = T

The resulting type after applying the / operator.

fn div(self, rhs: T) -> <CopyValue<T, S> as Div<T>>::Output

Performs the / operation.

impl<T, S> DivAssign<T> for CopyValue<T, S>

where T: Div<Output = T> + Copy + 'static, S: Storage<T>,

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<T, S> Mul<T> for CopyValue<T, S>

where T: Mul<Output = T> + Copy + 'static, S: Storage<T>,

type Output = T

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> <CopyValue<T, S> as Mul<T>>::Output

Performs the * operation.

impl<T, S> MulAssign<T> for CopyValue<T, S>

where T: Mul<Output = T> + Copy + 'static, S: Storage<T>,

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<T, S> PartialEq<T> for CopyValue<T, S>

where T: PartialEq + 'static, S: Storage<T>,

fn eq(&self, other: &T) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, S> PartialEq for CopyValue<T, S>

where T: 'static, S: Storage<T>,

fn eq(&self, other: &CopyValue<T, S>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T, S> Readable for CopyValue<T, S>

where T: 'static, S: Storage<T>,

type Target = T

The target type of the reference.

type Storage = S

The type of the storage this readable uses.

fn try_read_unchecked( &self ) -> Result<<<CopyValue<T, S> as Readable>::Storage as AnyStorage>::Ref<'static, <CopyValue<T, S> as Readable>::Target>, BorrowError>

Try to get a reference to the value without checking the lifetime. This will subscribe the current scope to the signal.

fn try_peek_unchecked( &self ) -> Result<<<CopyValue<T, S> as Readable>::Storage as AnyStorage>::Ref<'static, <CopyValue<T, S> as Readable>::Target>, BorrowError>

Try to peek the current value of the signal without subscribing to updates. If the value has been dropped, this will return an error.

fn map<O>( self, f: impl Fn(&Self::Target) -> &O + 'static ) -> MappedSignal<O, Self::Storage>

where Self: Sized + Clone + 'static,

Map the readable type to a new type. This lets you provide a view into a readable type without needing to clone the inner value.

fn read(&self) -> <Self::Storage as AnyStorage>::Ref<'_, Self::Target>

Get the current value of the state. If this is a signal, this will subscribe the current scope to the signal. If the value has been dropped, this will panic. Calling this on a Signal is the same as using the signal() syntax to read and subscribe to its value

fn try_read( &self ) -> Result<<Self::Storage as AnyStorage>::Ref<'_, Self::Target>, BorrowError>

Try to get the current value of the state. If this is a signal, this will subscribe the current scope to the signal.

fn read_unchecked( &self ) -> <Self::Storage as AnyStorage>::Ref<'static, Self::Target>

Get a reference to the value without checking the lifetime. This will subscribe the current scope to the signal.

fn peek(&self) -> <Self::Storage as AnyStorage>::Ref<'_, Self::Target>

Get the current value of the state without subscribing to updates. If the value has been dropped, this will panic.

fn try_peek( &self ) -> Result<<Self::Storage as AnyStorage>::Ref<'_, Self::Target>, BorrowError>

Try to peek the current value of the signal without subscribing to updates. If the value has been dropped, this will return an error.

fn peek_unchecked( &self ) -> <Self::Storage as AnyStorage>::Ref<'static, Self::Target>

Get the current value of the signal without checking the lifetime. Unlike read, this will not subscribe the current scope to the signal which can cause parts of your UI to not update.

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

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

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

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

fn index<I>( &self, index: I ) -> <Self::Storage as AnyStorage>::Ref<'_, <Self::Target as Index<I>>::Output>

where Self::Target: Index<I>,

Index into the inner value and return a reference to the result. If the value has been dropped or the index is invalid, this will panic.

impl<T, S> Sub<T> for CopyValue<T, S>

where T: Sub<Output = T> + Copy + 'static, S: Storage<T>,

type Output = T

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> <CopyValue<T, S> as Sub<T>>::Output

Performs the - operation.

impl<T, S> SubAssign<T> for CopyValue<T, S>

where T: Sub<Output = T> + Copy + 'static, S: Storage<T>,

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

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>

The type of the reference.

fn map_mut<I, U, F>( mut_: <CopyValue<T, S> as Writable>::Mut<'_, I>, f: F ) -> <CopyValue<T, S> as Writable>::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>( mut_: <CopyValue<T, S> as Writable>::Mut<'_, I>, f: F ) -> Option<<CopyValue<T, S> as Writable>::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, R>( mut_: <CopyValue<T, S> as Writable>::Mut<'a, R> ) -> <CopyValue<T, S> as Writable>::Mut<'b, R>

where 'a: 'b, R: 'static + ?Sized,

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

fn try_write_unchecked( &self ) -> Result<<CopyValue<T, S> as Writable>::Mut<'static, <CopyValue<T, S> as Readable>::Target>, BorrowMutError>

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

fn set(&mut self, value: T)

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

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.

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 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.

impl<T, S> Copy for CopyValue<T, S>

where S: Storage<T>,

impl<T, S> Eq for CopyValue<T, S>

where T: 'static, S: Storage<T>,