Skip to main content

SettingsStore

Struct SettingsStore 

Source
pub struct SettingsStore { /* private fields */ }
Expand description

Native JSON settings store.

All get/set/remove/contains/keys operations are synchronous (in-memory). Only open and save are async (matching the wasm32 sibling API).

Implementations§

Source§

impl SettingsStore

Source

pub async fn open( root: impl AsRef<Path>, namespace: &str, ) -> Result<Self, SettingsError>

Open (or create) a settings store.

root — directory that will contain the settings file. namespace — base name of the file ({namespace}.json).

Creates parent directories if missing. If the file exists it is parsed into the in-memory map; a corrupt or unreadable file returns Err rather than silently wiping it.

Source

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

Look up a key and deserialize it as T.

Returns None when the key is absent or the value cannot be deserialized as T (wrong type — not a panic).

Source

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

Serialize value as JSON and insert it under key.

The store is only modified in memory; call save() to persist.

Source

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

Remove a key. Returns true if the key was present.

Source

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

Return all keys in the store (order unspecified).

Source

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

Return true if key exists in the store.

Source

pub async fn save(&self) -> Result<(), SettingsError>

Persist the in-memory map to disk atomically.

Writes to {path}.tmp first, then renames it over path. This ensures the previous file is never partially overwritten on a crash.

Trait Implementations§

Source§

impl Debug for SettingsStore

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> 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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more