Struct cushy::value::DynamicReader

pub struct DynamicReader<T> { /* private fields */ }

A reader of a Dynamic<T> that tracks the last generation accessed.

Implementations

impl DynamicReader<WidgetInstance>

pub fn into_switcher(self) -> Switcher

Returns a new Switcher widget whose contents is the value of this dynamic reader.

pub fn to_switcher(&self) -> Switcher

Returns a new Switcher widget whose contents is the value of this dynamic reader.

impl<T> DynamicReader<T>

pub fn lock(&self) -> DynamicGuard<'_, T, true>

Returns an read-only, exclusive reference to the contents of this dynamic.

This call will block until all other guards for this dynamic have been dropped.

Panics

This function panics if this value is already locked by the current thread.

pub fn read_generation(&self) -> Generation

Returns the current generation that has been accessed through this reader.

pub fn has_updated(&self) -> bool

Returns true if the dynamic has been modified since the last time the value was accessed through this reader.

Panics

This function panics if this value is already locked by the current thread.

pub fn block_until_updated(&self) -> bool

Blocks the current thread until the contained value has been updated or there are no remaining writers for the value.

Returns true if a newly updated value was discovered.

Panics

This function panics if this value is already locked by the current thread.

pub fn connected(&self) -> bool

Returns true if this reader still has any writers connected to it.

pub fn wait_until_updated(&self) -> BlockUntilUpdatedFuture<'_, T>

Suspends the current async task until the contained value has been updated or there are no remaining writers for the value.

Returns true if a newly updated value was discovered.

pub fn on_disconnect<OnDisconnect>(&self, on_disconnect: OnDisconnect)

where OnDisconnect: FnOnce() + Send + 'static,

Invokes on_disconnect when no instances of Dynamic<T> exist.

This callback will be invoked even if this DynamicReader has been dropped.

Panics

This function panics if this value is already locked by the current thread.

Trait Implementations

impl<T> Clone for DynamicReader<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for DynamicReader<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Drop for DynamicReader<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> DynamicRead<T> for DynamicReader<T>

fn read(&self) -> DynamicGuard<'_, T, true>

Returns a guard that provides exclusive, read-only access to the value contained wihtin this dynamic.

impl<T> From<Dynamic<T>> for DynamicReader<T>

fn from(value: Dynamic<T>) -> Self

Converts to this type from the input type.

impl<T> From<DynamicReader<T>> for ReadOnly<T>

fn from(value: DynamicReader<T>) -> Self

Converts to this type from the input type.

impl<T> IntoReadOnly<T> for DynamicReader<T>

fn into_read_only(self) -> ReadOnly<T>

Returns self as a ReadOnly.

impl<T> IntoReader<T> for DynamicReader<T>

fn into_reader(self) -> DynamicReader<T>

Returns this value as a reader.

impl<T> Source<T> for DynamicReader<T>

fn try_map_generational<R>( &self, map: impl FnOnce(DynamicGuard<'_, T, true>) -> R, ) -> Result<R, DeadlockError>

Maps the contents with read-only access, providing access to the value’s Generation.

fn for_each_subsequent_generational_try<F>(&self, for_each: F) -> CallbackHandle

where T: Send + 'static, F: for<'a> FnMut(DynamicGuard<'_, T, true>) -> Result<(), CallbackDisconnected> + Send + 'static,

Attaches for_each to this value so that it is invoked each time the source’s contents are updated.

fn for_each_generational_cloned_try<F>(&self, for_each: F) -> CallbackHandle

where T: Clone + Send + 'static, F: FnMut(GenerationalValue<T>) -> Result<(), CallbackDisconnected> + Send + 'static,

Invokes for_each with the current contents and each time this source’s contents are updated.

fn map_generational<R>( &self, map: impl FnOnce(DynamicGuard<'_, T, true>) -> R, ) -> R

Maps the contents with read-only access, providing access to the value’s Generation.

fn generation(&self) -> Generation

Returns the current generation of the value.

fn map_ref<R>(&self, map: impl FnOnce(&T) -> R) -> R

Maps the contents with read-only access.

fn try_map_ref<R>(&self, map: impl FnOnce(&T) -> R) -> Result<R, DeadlockError>

Maps the contents with read-only access.