Struct Store 

pub struct Store { /* private fields */ }

A mod’s store of a scope: values of any Schema type by key, kept in memory and written when it’s flushed. Handles to one store share it.

Implementations

impl Store

pub fn open(root: &Path, mod_id: &str, scope: Scope<'_>) -> Store

mod_id’s store of scope under root (the game’s folder or the world’s).

pub fn session(mod_id: &str) -> Store

mod_id’s session store: kept while the game runs, never written.

pub fn get<T>(&self, key: &str) -> Option<T>

where T: Schema,

The value at key, if there’s one of type T.

pub fn get_or_default<T>(&self, key: &str) -> T

where T: Schema + Default,

The value at key, or T’s default.

pub fn set<T>(&self, key: &str, value: &T)

where T: Schema,

value at key.

pub fn record(&self, key: &str) -> Option<Vec<u8>>

The record at key: bytes kept as they were given (Store::set_record), never decoded — what a Yog Script object’s state is.

pub fn set_record(&self, key: &str, bytes: &[u8])

bytes at key as a record: kept and written as they are (its owner’s codec reads them back).

pub fn remove_under(&self, prefix: &str) -> usize

Takes out every value whose key starts with prefix; how many.

pub fn update<T, R>(&self, key: &str, change: impl FnOnce(&mut T) -> R) -> R

where T: Schema + Default,

The value at key changed by change (its default when there’s none); what change returns.

pub fn remove(&self, key: &str) -> bool

Takes the value at key out; whether there was one.

pub fn contains(&self, key: &str) -> bool

pub fn keys(&self) -> Vec<String>

Every key, in the order they were first set.

pub fn flush(&self) -> Result<(), Error>

Writes it now if it changed (else it’s written with every store, see crate::flush_all).

Trait Implementations

impl Clone for Store

fn clone(&self) -> Store

Returns a duplicate of the value.

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

Performs copy-assignment from source.