Struct dioxus_hooks::UseState

pub struct UseState<'a, T: 'static>(_);

Implementations

impl<'a, T: 'static> UseState<'a, T>

pub fn needs_update(&self)

Tell the Dioxus Scheduler that we need to be processed

pub fn set(&self, new_val: T)

pub fn get(&self) -> &'a T

pub fn get_rc(&self) -> &'a Rc<T>

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

Get the current status of the work-in-progress data

pub fn get_wip_mut(&self) -> RefMut<'_, Option<T>>

Get the current status of the work-in-progress data

pub fn classic(self) -> (&'a T, Rc<dyn Fn(T)>)

pub fn setter(&self) -> Rc<dyn Fn(T)>

pub fn wtih(&self, f: impl FnOnce(&mut T))

pub fn for_async(&self) -> UseStateOwned<T>

impl<'a, T: 'static + ToOwned<Owned = T>> UseState<'a, T>

pub fn modify(self) -> RefMut<'a, T>

Gain mutable access to the new value via RefMut.

If modify is called, then the component will re-render.

This method is only available when the value is a ToOwned type.

Mutable access is derived by calling “ToOwned” (IE cloning) on the current value.

To get a reference to the current value, use .get()

pub fn inner(self) -> T

Trait Implementations

impl<'a, T: Copy + Add<T, Output = T>> Add<T> for UseState<'a, T>

type Output = T

The resulting type after applying the + operator.

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

Performs the + operation.

impl<'a, T: Copy + Add<T, Output = T>> AddAssign<T> for UseState<'a, T>

fn add_assign(&mut self, rhs: T)

Performs the += operation.

impl<'a, T: 'static> Clone for UseState<'a, 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 UseState<'_, T>

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

Formats the value using the given formatter.

impl<'a, T> Deref for UseState<'a, T>

type Target = T

The resulting type after dereferencing.

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

Dereferences the value.

impl<'a, T: 'static + Display> Display for UseState<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: Copy + Div<T, Output = T>> Div<T> for UseState<'a, T>

DIV

type Output = T

The resulting type after applying the / operator.

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

Performs the / operation.

impl<'a, T: Copy + Div<T, Output = T>> DivAssign<T> for UseState<'a, T>

fn div_assign(&mut self, rhs: T)

Performs the /= operation.

impl<'a, T: Copy + Mul<T, Output = T>> Mul<T> for UseState<'a, T>

MUL

type Output = T

The resulting type after applying the * operator.

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

Performs the * operation.

impl<'a, T: Copy + Mul<T, Output = T>> MulAssign<T> for UseState<'a, T>

fn mul_assign(&mut self, rhs: T)

Performs the *= operation.

impl<'a, O, T: Not<Output = O> + Copy> Not for UseState<'a, T>

type Output = O

The resulting type after applying the ! operator.

fn not(self) -> Self::Output

Performs the unary ! operation.

impl<'a, V, T: PartialEq<V>> PartialEq<V> for UseState<'a, T>

fn eq(&self, other: &V) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl<'a, T: Copy + Sub<T, Output = T>> Sub<T> for UseState<'a, T>

Sub

type Output = T

The resulting type after applying the - operator.

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

Performs the - operation.

impl<'a, T: Copy + Sub<T, Output = T>> SubAssign<T> for UseState<'a, T>

fn sub_assign(&mut self, rhs: T)

Performs the -= operation.

impl<T> Copy for UseState<'_, T>