Struct rustcn_ui::CopyValue

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 take(&self) -> T

Take the value out of 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.

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

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

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

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

Returns a copy of the value. Read more

1.0.0 · source§

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

Performs copy-assignment from source. Read more

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

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

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

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

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

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

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

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

1.0.0 · source§

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

1.0.0 · source§

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( &self ) -> Result<<<CopyValue<T, S> as Readable>::Storage as AnyStorage>::Ref<<CopyValue<T, S> as Readable>::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. If the value has been dropped, this will panic.

fn peek( &self ) -> <<CopyValue<T, S> as Readable>::Storage as AnyStorage>::Ref<<CopyValue<T, S> as Readable>::Target>

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

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

Map the readable type to a new type.

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.

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( &self, index: I ) -> <Self::Storage as AnyStorage>::Ref<<Self::Target as Index>::Output>
where Self::Target: Index,

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

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

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

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

The type of the reference.

fn map_mut<I, U, F>( mut_: <CopyValue<T, S> as Writable>::Mut, f: F ) -> <CopyValue<T, S> as Writable>::Mut
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, f: F ) -> Option<<CopyValue<T, S> as Writable>::Mut>
where F: FnOnce(&mut I) -> Option<&mut U>, I: ?Sized, U: ?Sized,

Try to map the reference to a new type.

fn try_write( &self ) -> Result<<CopyValue<T, S> as Writable>::Mut<T>, BorrowMutError>

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

fn write(&mut self) -> <CopyValue<T, S> as Writable>::Mut<T>

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

fn set(&mut self, value: T)

Set the value of the signal. This will trigger an update on all 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( &mut self, index: I ) -> Self::Mut<<Self::Target as Index>::Output>
where Self::Target: IndexMut,

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

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

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

Auto Trait Implementations§

impl<T, S = UnsyncStorage> !UnwindSafe for CopyValue<T, S>

Blanket Implementations§

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

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

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

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

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

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

Mutably borrows from an owned value. Read more

impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

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

fn into(self) -> U

Calls U::from(self).

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

impl<T, R> ReadableOptionExt<T> for R
where T: 'static, R: Readable<Target = Option<T>>,

fn unwrap(&self) -> T
where T: Clone,

Unwraps the inner value and clones it.

fn as_ref(&self) -> Option<<Self::Storage as AnyStorage>::Ref<T>>

Attempts to read the inner value of the Option.

impl<T, R> ReadableVecExt<T> for R
where T: 'static, R: Readable<Target = Vec<T>>,

fn len(&self) -> usize

Returns the length of the inner vector.

fn is_empty(&self) -> bool

Returns true if the inner vector is empty.

fn first(&self) -> Option<<Self::Storage as AnyStorage>::Ref<T>>

Get the first element of the inner vector.

fn last(&self) -> Option<<Self::Storage as AnyStorage>::Ref<T>>

Get the last element of the inner vector.

fn get(&self, index: usize) -> Option<<Self::Storage as AnyStorage>::Ref<T>>

Get the element at the given index of the inner vector.

fn iter(&self) -> ReadableValueIterator<'_, Self> ⓘ
where Self: Sized,

Get an iterator over the values of the inner vector.

impl<T, O> SuperFrom<T> for O
where O: From<T>,

fn super_from(input: T) -> O

Convert from a type to another type.

impl<T, O, M> SuperInto<O, M> for T
where O: SuperFrom<T, M>,

fn super_into(self) -> O

Convert from a type to another type.

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

fn to<T>(self) -> T
where Self: Into<T>,

Converts to T by calling Into<T>::into.

fn try_to<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Tries to convert to T by calling TryInto<T>::try_into.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T> ToString for T
where T: Display + ?Sized,

default fn to_string(&self) -> String

Converts the given value to a String. Read more

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

type Error = Infallible

The type returned in the event of a conversion error.

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

Performs the conversion.

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

type Error = >::Error

The type returned in the event of a conversion error.

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

Performs the conversion.

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more

impl<T, W> WritableOptionExt<T> for W
where T: 'static, W: Writable<Target = Option<T>>,

fn get_or_insert(&mut self, default: T) -> Self::Mut<T>

Gets the value out of the Option, or inserts the given value if the Option is empty.

fn get_or_insert_with(&mut self, default: impl FnOnce() -> T) -> Self::Mut<T>

Gets the value out of the Option, or inserts the value returned by the given function if the Option is empty.

fn as_mut(&mut self) -> Option<Self::Mut<T>>

Attempts to write the inner value of the Option.

impl<T, W> WritableVecExt<T> for W
where T: 'static, W: Writable<Target = Vec<T>>,

fn push(&mut self, value: T)

Pushes a new value to the end of the vector.

fn pop(&mut self) -> Option<T>

Pops the last value from the vector.

fn insert(&mut self, index: usize, value: T)

Inserts a new value at the given index.

fn remove(&mut self, index: usize) -> T

Removes the value at the given index.

fn clear(&mut self)

Clears the vector, removing all values.

fn extend(&mut self, iter: impl IntoIterator<Item = T>)

Extends the vector with the given iterator.

fn truncate(&mut self, len: usize)

Truncates the vector to the given length.

fn swap_remove(&mut self, index: usize) -> T

Swaps two values in the vector.

fn retain(&mut self, f: impl FnMut(&T) -> bool)

Retains only the values that match the given predicate.

fn split_off(&mut self, at: usize) -> Vec<T>

Splits the vector into two at the given index.

fn get_mut(&mut self, index: usize) -> Option<Self::Mut<T>>

Try to mutably get an element from the vector.

fn iter_mut(&self) -> WritableValueIterator<Self> ⓘ
where Self: Sized + Clone,

Gets an iterator over the values of the vector.