Struct Reference

pub struct Reference<T: Default + 'static> { /* private fields */ }

A reference with interior mutability. Somewhat like RefCell. Returned by use_ref.

This can be read from and written to anytime. Writing to it does not trigger rerender.

This is often not neccessary. Use super::use_state() instead.

Implementations

impl<T: Default + 'static> Reference<T>

pub fn visit_with<Ret: 'static, F: FnOnce(&T) -> Ret>( &self, func: F, ) -> Result<Ret, SubtreeUnmountedError>

Run the given closure with a borrow of the data inside the Reference as argument.

Returns a Result with the Ok variant being the return value of your closure.

The error variant is SubtreeUnmountedError. This error is thrown if this function is called when the subtree where the use_ref this comes from had been unmounted.

pub fn visit_mut_with<Ret: 'static, F: FnOnce(&mut T) -> Ret>( &self, func: F, ) -> Result<Ret, SubtreeUnmountedError>

Run the given closure with a mutable borrow of the data inside the Reference as argument.

Returns a Result with the Ok variant being the return value of your closure.

The error variant is SubtreeUnmountedError. This error is thrown if this function is called when the subtree where the use_ref this comes from had been unmounted.

pub fn set_in(&self, value: T) -> Result<(), SubtreeUnmountedError>

Set the value in the Ref to the given value.

This does not trigger a rerender.

The error variant is SubtreeUnmountedError. This error is thrown if this function is called when the subtree where the use_ref this comes from had been unmounted.

impl<T: Clone + Default + 'static> Reference<T>

pub fn clone_out(&self) -> Result<T, SubtreeUnmountedError>

Return a clone of the value inside the Ref.

The Ok variant is said value.

The error variant is SubtreeUnmountedError. This error is thrown if this function is called when the subtree where the use_ref this comes from had been unmounted.

Trait Implementations

impl<T: Clone + Default + 'static> Clone for Reference<T>

fn clone(&self) -> Reference<T>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Default + 'static> PartialEq for Reference<T>

fn eq(&self, other: &Reference<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.