Struct bevy_pkv::PkvStore

pub struct PkvStore { /* private fields */ }

Main resource for setting/getting values

Implementations

impl PkvStore

pub fn new(organization: &str, application: &str) -> Self

Creates or opens a persistent key value store

The given organization and application are used to create a backing file in a corresponding location on the users device. Usually within the home or user folder

pub fn new_with_qualifier( qualifier: &str, organization: &str, application: &str ) -> Self

Creates or opens a persistent key value store

Like PkvStore::new, but also provide a qualifier. Some operating systems use the qualifier as part of the path to the store. The qualifier is usually “com”, “org” etc.

pub fn new_in_dir<P: AsRef<Path>>(path: P) -> Self

Creates or opens a persistent key value store

Like PkvStore::new, but requires a direct path. The path is used to create a backing file in a corresponding location on the users device.

pub fn set<T: Serialize>( &mut self, key: impl AsRef<str>, value: &T ) -> Result<(), SetError>

Serialize and store the value

pub fn set_string( &mut self, key: impl AsRef<str>, value: &str ) -> Result<(), SetError>

More or less the same as set::, but can take a &str

pub fn get<T: DeserializeOwned>( &self, key: impl AsRef<str> ) -> Result<T, GetError>

Get the value for the given key returns Err(GetError::NotFound) if the key does not exist in the key value store.

pub fn clear(&mut self) -> Result<(), SetError>

Clear all key values data returns Err(SetError) if clear error

Trait Implementations

impl Debug for PkvStore

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

Formats the value using the given formatter.

impl Resource for PkvStore

where Self: Send + Sync + 'static,