Struct CopyValue 

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

Available on crate feature prelude only.

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 S: Storage<T>,

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

where T: 'static,

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 leak_with_caller( value: T, caller: &'static Location<'static>, ) -> CopyValue<T, S>

where T: 'static,

Create a new CopyValue without an owner. This will leak memory if you don’t manually drop it.

pub fn point_to(&self, other: CopyValue<T, S>) -> Result<(), BorrowError>

Point to another copy value

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)

where T: 'static,

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>

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

Returns a duplicate 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 + 'static, 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> From<CopyValue<T, S>> for ReadSignal<T, S>

where T: 'static, S: CreateBoxedSignalStorage<CopyValue<T, S>> + BoxedSignalStorage<T> + Storage<T>,

fn from(value: CopyValue<T, S>) -> ReadSignal<T, S>

Converts to this type from the input type.

impl<T, S> From<CopyValue<T, S>> for WriteSignal<T, S>

where T: 'static, S: CreateBoxedSignalStorage<CopyValue<T, S>> + BoxedSignalStorage<T> + Storage<T>,

fn from(value: CopyValue<T, S>) -> WriteSignal<T, S>

Converts to this type from the input type.

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

Tests for self and other values to be equal, and is used by ==.

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

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 S: AnyStorage,

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

Tests for self and other values to be equal, and is used by ==.

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

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 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 subscribers(&self) -> Subscribers

Get the underlying subscriber list for this readable. This is used to track when the value changes and notify subscribers.

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 S: Storage<T>,

type WriteMetadata = ()

Additional data associated with the write reference.

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

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

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

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

where S: AnyStorage,