Struct ambient_api::prelude::State

pub struct State<T>(/* private fields */)
where
    T: ?Sized;

A wrapper for Arc<RwLock<T>> to simplify passing complex state around callbacks.

Where possible, prefer using the ECS and storing data in (custom) components. This allows other modules to introspect your module’s state, and is generally easier to work with (as EntityId is Copy, unlike this type.)

Implementations

impl<T> State<T>

pub fn new(value: T) -> State<T>

Creates a new State with the given value.

pub fn read(&self) -> RwLockReadGuard<'_, T>

Immutably borrows the state. Use this to access the state without modifying it.

pub fn write(&self) -> RwLockWriteGuard<'_, T>

Mutably borrows the state. Use this to modify the state.

Trait Implementations

impl<T> Clone for State<T>

where T: ?Sized,

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

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for State<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for State<T>

where T: Default,

fn default() -> State<T>

Returns the “default value” for a type.

impl<T> Display for State<T>

where T: Display,

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

Formats the value using the given formatter.