Struct State 

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

Handle to state created by use_state(). Access via .get(ui) / .get_mut(ui).

Note on Copy

As of v0.20.0, State<T> is no longer Copy. The internal key may hold an owned String (for Context::use_state_keyed), which prevents trivial duplication. Existing call sites that use the handle locally (let s = ui.use_state(...); s.get(ui);) are unaffected — the handle is moved into closures or borrowed by reference. If you previously relied on implicit copy semantics, call .clone() explicitly.

Implementations

impl<T: 'static> State<T>

pub fn get<'a>(&self, ui: &'a Context) -> &'a T

Read the current value.

Panics

Panics if this handle’s slot or id contains a different concrete type, which means positional hooks changed order or the same named/keyed id was reused with another T. Named and keyed handles also panic if their backing entry was removed before access. The message identifies the hook index or id and the expected type.

pub fn get_mut<'a>(&self, ui: &'a mut Context) -> &'a mut T

Mutably access the current value.

Panics

Panics under the same slot, id, and type-mismatch conditions as get.

Trait Implementations

impl<T: Clone> Clone for State<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for State<T>

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

Formats the value using the given formatter.

impl<T: Eq> Eq for State<T>

impl<T: PartialEq> PartialEq for State<T>

fn eq(&self, other: &State<T>) -> bool

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialEq> StructuralPartialEq for State<T>