Skip to main content

JsonFileStore

Struct JsonFileStore 

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

JSON-file-backed state store.

Each namespace is a single JSON file at {root}/{namespace}.json. Writes are atomic: the new state is written to a .tmp sibling and then renamed.

The root directory is provided at construction time; callers are expected to resolve it from the service-layer AppDir abstraction (typically ~/.algocline/state/).

Implementations§

Source§

impl JsonFileStore

Source

pub fn new(root: PathBuf) -> Self

Construct a store rooted at an explicit path.

The directory is not created eagerly; it is created lazily on the first set / set_nx / incr call via Self::state_path.

Source

pub fn root(&self) -> &Path

Return the root directory this store writes under.

Source

pub fn state_path(&self, ns: &str) -> Result<PathBuf, String>

Resolve the JSON file path for a namespace, validating the name and creating the root directory on demand.

Trait Implementations§

Source§

impl StateStore for JsonFileStore

Source§

fn get(&self, ns: &str, key: &str) -> Result<Option<Value>, String>

Read a value. Returns None if the key does not exist.
Source§

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

Write a value (upsert).
Source§

fn delete(&self, ns: &str, key: &str) -> Result<bool, String>

Remove a key. Returns true if it existed.
Source§

fn keys(&self, ns: &str) -> Result<Vec<String>, String>

List all keys in a namespace.
Source§

fn has(&self, ns: &str, key: &str) -> Result<bool, String>

Check whether a key exists. Read more
Source§

fn set_nx(&self, ns: &str, key: &str, value: Value) -> Result<bool, String>

Set a value only if the key does not already exist. Returns true if the value was written, false if the key was already present. Read more
Source§

fn incr( &self, ns: &str, key: &str, delta: f64, default: f64, ) -> Result<f64, String>

Counter increment (single-process atomic). 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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
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
Source§

impl<T> MaybeSend for T
where T: Send,