Struct wasm_react::hooks::RefContainer

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

Allows access to the underlying data persisted with use_ref().

Panics

The rules of borrowing will be enforced at runtime through a RefCell, therefore the methods RefContainer::current(), RefContainer::current_mut(), and RefContainer::set_current() may panic accordingly.

Implementations

impl<T: 'static> RefContainer<T>

pub fn current(&self) -> Ref<'_, T>

Returns a reference to the underlying data.

Panics

Panics if the underlying data is currently mutably borrowed.

pub fn current_mut(&mut self) -> RefMut<'_, T>

Returns a mutable reference to the underlying data.

Panics

Panics if the underlying data is currently borrowed.

pub fn set_current(&mut self, value: T)

Sets the underlying data to the given value.

Panics

Panics if the underlying data is currently borrowed.

pub unsafe fn try_from_js_ref(
    js_value: &JsValue
) -> Result<RefContainer<T>, JsValue>

Converts a JS value into a RefContainer.

Safety

The following assumptions must hold:

• The JS value has been obtained by creating a RefContainer using use_ref() and converting it into JsValue.
• The React component owning the RefContainer hasn’t been unmounted.

Otherwise this might lead to memory issues.

Trait Implementations

impl<T> AsRef<JsValue> for RefContainer<T>

fn as_ref(&self) -> &JsValue

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Clone for RefContainer<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> Debug for RefContainer<T>

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

Formats the value using the given formatter.

impl<T> From<RefContainer<T>> for ValueContainer<T>

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

Converts to this type from the input type.

impl<T> From<RefContainer<T>> for JsValue

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

Converts to this type from the input type.

impl<T: 'static> Persisted for RefContainer<T>