Struct Storage 

pub struct Storage { /* private fields */ }

The game’s data folder.

Implementations

impl Storage

pub fn new(root: &Path) -> Self

Storage rooted at a folder (created on first write).

pub fn for_game(game: &str) -> Self

The standard folder for a game: %APPDATA%/Kvas/<game> on Windows, ~/.local/share/kvas/<game> elsewhere.

pub fn root(&self) -> &Path

The data folder.

pub fn set_scene(&mut self, scene: &str)

Records the running scene (written into saves).

pub fn save(&self, slot: &str, title: &str, data: &Value) -> Result<(), String>

Writes a save slot. title is what a load menu shows.

pub fn load(&self, slot: &str) -> Option<Value>

Reads a save slot’s data.

pub fn save_as<T: Serialize>( &self, slot: &str, title: &str, value: &T, ) -> Result<(), String>

Typed save: any Serialize value.

pub fn load_as<T: for<'de> Deserialize<'de>>(&self, slot: &str) -> Option<T>

Typed load.

pub fn slots(&self) -> Vec<SaveInfo>

Every save, newest first.

pub fn has_save(&self, slot: &str) -> bool

Whether a slot exists.

pub fn delete_save(&self, slot: &str) -> Result<(), String>

Removes a slot.

pub fn settings(&self) -> Map<String, Value>

All settings.

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

One setting.

pub fn set_setting(&self, key: &str, value: Value) -> Result<(), String>

Changes one setting and writes the file.

pub fn read_text(&self, rel: &str) -> Result<String, String>

Reads a text file of the data folder.

pub fn write_text(&self, rel: &str, text: &str) -> Result<(), String>

Writes a text file (folders are created).

pub fn read_bytes(&self, rel: &str) -> Result<Vec<u8>, String>

Reads bytes.

pub fn write_bytes(&self, rel: &str, bytes: &[u8]) -> Result<(), String>

Writes bytes (folders are created).

pub fn append_line(&self, rel: &str, line: &str) -> Result<(), String>

Appends a line (logs, statistics).

pub fn exists(&self, rel: &str) -> bool

Whether a file or folder exists.

pub fn list(&self, rel: &str) -> Vec<String>

Names in a folder ("" = the data folder itself), folders end with /.

pub fn delete(&self, rel: &str) -> Result<(), String>

Removes a file or a whole folder.

Trait Implementations

impl Clone for Storage

fn clone(&self) -> Storage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Storage

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

Formats the value using the given formatter.

impl Default for Storage

fn default() -> Storage

Returns the “default value” for a type.