Struct CopyValue 

pub struct CopyValue<T, S: 'static = UnsyncStorage> { /* 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: 'static> CopyValue<T>

pub fn new(value: T) -> Self

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) -> Self

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

pub fn new_maybe_sync(value: T) -> Self

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>) -> Self

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: Self) -> BorrowResult

Point to another copy value

pub fn new_maybe_sync_in_scope(value: T, scope: ScopeId) -> Self

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>, ) -> Self

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: Add<Output = T> + Copy + 'static, S: Storage<T>> Add<T> for CopyValue<T, S>

type Output = T

The resulting type after applying the + operator.

fn add(self, rhs: T) -> Self::Output

Performs the + operation.

impl<T: Add<Output = T> + Copy + 'static, S: Storage<T>> AddAssign<T> for CopyValue<T, S>

fn add_assign(&mut self, rhs: T)

Performs the += operation.

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

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug + 'static, S: Storage<T>> Debug for CopyValue<T, S>

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

Formats the value using the given formatter.

impl<T: Default + 'static, S: Storage<T>> Default for CopyValue<T, S>

fn default() -> Self

Returns the “default value” for a type.

impl<T: Copy + 'static, S: Storage<T>> Deref for CopyValue<T, S>

type Target = dyn Fn() -> T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T: Display + 'static, S: Storage<T>> Display for CopyValue<T, S>

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

Formats the value using the given formatter.

impl<T: Div<Output = T> + Copy + 'static, S: Storage<T>> Div<T> for CopyValue<T, S>

type Output = T

The resulting type after applying the / operator.

fn div(self, rhs: T) -> Self::Output

Performs the / operation.

impl<T: Div<Output = T> + Copy + 'static, S: Storage<T>> DivAssign<T> for CopyValue<T, S>

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<T: 'static, S: CreateBoxedSignalStorage<CopyValue<T, S>> + BoxedSignalStorage<T> + Storage<T>> From<CopyValue<T, S>> for ReadSignal<T, S>

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

Converts to this type from the input type.

impl<T: 'static, S: CreateBoxedSignalStorage<CopyValue<T, S>> + BoxedSignalStorage<T> + Storage<T>> From<CopyValue<T, S>> for WriteSignal<T, S>

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

Converts to this type from the input type.

impl<T: Mul<Output = T> + Copy + 'static, S: Storage<T>> Mul<T> for CopyValue<T, S>

type Output = T

The resulting type after applying the * operator.

fn mul(self, rhs: T) -> Self::Output

Performs the * operation.

impl<T: Mul<Output = T> + Copy + 'static, S: Storage<T>> MulAssign<T> for CopyValue<T, S>

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<T: PartialEq + 'static, S: Storage<T>> PartialEq<T> for CopyValue<T, S>

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: AnyStorage> PartialEq for CopyValue<T, S>

fn eq(&self, other: &Self) -> 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: Storage<T>> Readable for CopyValue<T, S>

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<ReadableRef<'static, Self>, 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) -> BorrowResult<ReadableRef<'static, Self>>

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: Sub<Output = T> + Copy + 'static, S: Storage<T>> Sub<T> for CopyValue<T, S>

type Output = T

The resulting type after applying the - operator.

fn sub(self, rhs: T) -> Self::Output

Performs the - operation.

impl<T: Sub<Output = T> + Copy + 'static, S: Storage<T>> SubAssign<T> for CopyValue<T, S>

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl<T, S: Storage<T>> Writable for CopyValue<T, S>

type WriteMetadata = ()

Additional data associated with the write reference.

fn try_write_unchecked( &self, ) -> Result<WritableRef<'static, Self>, 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: AnyStorage> Eq for CopyValue<T, S>