Struct State

pub struct State<'r, T: Send + Sync + 'static>(/* private fields */);

A guard for a state value.

See Manager::manage for usage examples.

Implementations

impl<'r, T: Send + Sync + 'static> State<'r, T>

pub fn inner(&self) -> &'r T

Retrieve a borrow to the underlying value with a lifetime of 'r. Using this method is typically unnecessary as State implements std::ops::Deref with a std::ops::Deref::Target of T.

Trait Implementations

impl<T: Send + Sync + 'static> Clone for State<'_, T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'r, 'de: 'r, T: Send + Sync + 'static, R: Runtime> CommandArg<'de, R> for State<'r, T>

fn from_command(command: CommandItem<'de, R>) -> Result<Self, InvokeError>

Grabs the State from the CommandItem. This will never fail.

impl<T: Send + Sync + Debug> Debug for State<'_, T>

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

Formats the value using the given formatter.

impl<T: Send + Sync + 'static> Deref for State<'_, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &T

Dereferences the value.

impl<T: Send + Sync + 'static> FunctionArg for State<'_, T>

fn to_datatype(_: &mut TypeMap) -> Option<DataType>

Gets the type of an argument as a DataType.

impl<T: Send + Sync + 'static + PartialEq> PartialEq for State<'_, T>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.