Skip to main content

GameData

Struct GameData 

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

A value kept for the install, whatever world (<game>/yog-data/<mod>/game.ydata): written as it changes.

Implementations§

Source§

impl<T: Schema + Default + Send + 'static> GameData<T>

Source

pub const fn new(key: &'static str) -> Self

Source

pub fn with<R>(&'static self, read: impl FnOnce(&T) -> R) -> R

What read makes of the value.

Source

pub fn with_mut<R>(&'static self, change: impl FnOnce(&mut T) -> R) -> R

The value changed by change, and written.

Auto Trait Implementations§

§

impl<T> !Freeze for GameData<T>

§

impl<T> RefUnwindSafe for GameData<T>

§

impl<T> Send for GameData<T>
where Mutex<Option<T>>: Send,

§

impl<T> Sync for GameData<T>
where Mutex<Option<T>>: Sync,

§

impl<T> Unpin for GameData<T>
where Mutex<Option<T>>: Unpin,

§

impl<T> UnsafeUnpin for GameData<T>

§

impl<T> UnwindSafe for GameData<T>
where Mutex<Option<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> Arg<T> for T

Source§

fn arg(self) -> T

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> 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, 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.