Skip to main content

State

ntui::hooks::state

Struct State 

Source 
pub struct State<T> { /* private fields */ }
Expand description

Owned component state. Clonable and Send (if T: Send) so it can be moved into hook-spawned tasks; setting it marks the owning fiber dirty. Locking recovers from poisoning: a panicking update closure cannot permanently brick the cell.

Implementations§

Source§

impl<T: 'static> State<T>

Source

pub fn set(&self, value: T)

Replaces the stored value and marks the owning fiber dirty for re-render.

Source

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

Mutates the stored value in place via f and marks the owning fiber dirty for re-render.

Source§

impl<T: Clone + 'static> State<T>

Source

pub fn get(&self) -> T

Returns a clone of the current value.

Trait Implementations§

Source§

impl<T> Clone for State<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

§

impl<T> Freeze for State<T>
where Arc<Mutex<T>>: Freeze,

§

impl<T> RefUnwindSafe for State<T>
where Arc<Mutex<T>>: RefUnwindSafe,

§

impl<T> Send for State<T>
where Arc<Mutex<T>>: Send,

§

impl<T> Sync for State<T>
where Arc<Mutex<T>>: Sync,

§

impl<T> Unpin for State<T>
where Arc<Mutex<T>>: Unpin,

§

impl<T> UnsafeUnpin for State<T>
where Arc<Mutex<T>>: UnsafeUnpin,

§

impl<T> UnwindSafe for State<T>
where Arc<Mutex<T>>: UnwindSafe,

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

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

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

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

Source§

fn into(self) -> U

Calls U::from(self).

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

Source§

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

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.