Struct Storage 

pub struct Storage { /* private fields */ }

Typed, scoped persistent key-value store.

Mutations are buffered in memory. The store is auto-flushed on Drop if any key was mutated. Call flush explicitly when you need the data on disk immediately (e.g. end of a critical event handler).

Implementations

impl Storage

pub fn open(game_dir: &str, mod_id: &str) -> Storage

Open the global store for mod_id.

pub fn open_scoped( game_dir: &str, mod_id: &str, scope: StorageScope<'_>, ) -> Storage

Open a store with an explicit StorageScope.

pub fn open_player(game_dir: &str, mod_id: &str, player_uuid: &str) -> Storage

Open a per-player store (keyed by player UUID).

pub fn open_world(game_dir: &str, mod_id: &str, dimension: &str) -> Storage

Open a per-dimension store.

pub fn open_entity(game_dir: &str, mod_id: &str, entity_uuid: &str) -> Storage

Open a per-entity store (keyed by entity UUID).

pub fn open_chunk( game_dir: &str, mod_id: &str, dimension: &str, cx: i32, cz: i32, ) -> Storage

Open a per-chunk store.

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

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

pub fn get_int(&self, key: &str) -> Option<i64>

pub fn get_float(&self, key: &str) -> Option<f64>

pub fn get_bool(&self, key: &str) -> Option<bool>

pub fn get_bytes(&self, key: &str) -> Option<&[u8]>

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

pub fn set(&mut self, key: impl Into<String>, value: impl Into<Value>)

Insert or replace a value.

Accepts any type that implements Into<Value> — i64, f64, bool, &str, String, Vec<u8>, etc.

pub fn remove(&mut self, key: &str) -> Option<Value>

pub fn clear(&mut self)

pub fn len(&self) -> usize

pub fn is_empty(&self) -> bool

pub fn is_dirty(&self) -> bool

pub fn iter(&self) -> impl Iterator<Item = (&str, &Value)>

pub fn path(&self) -> &Path

Absolute path of the backing file.

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

Atomically write all data to disk.

Writes to <path>.kv.tmp first, then renames it over <path>. A crash mid-write leaves the previous on-disk state intact.

Trait Implementations

impl Drop for Storage

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.