Skip to main content

StateStore

Struct StateStore 

Source
pub struct StateStore {
    pub base_path: PathBuf,
}
Expand description

A filesystem-based persistent state store.

Files are organized as <base_path>/<category>/<name>.md or <base_path>/<category>/<name>.json.

Fields§

§base_path: PathBuf

Root directory for all state files.

Implementations§

Source§

impl StateStore

Source

pub fn new(base_path: PathBuf) -> Result<Self>

Creates a new state store, initializing the directory if needed.

§Example
use oxios_kernel::state_store::StateStore;
use std::path::PathBuf;

let store = StateStore::new(PathBuf::from("/tmp/oxios-state")).unwrap();
Source

pub async fn save_markdown( &self, category: &str, name: &str, content: &str, ) -> Result<()>

Save a markdown file under the given category.

Source

pub async fn load_markdown( &self, category: &str, name: &str, ) -> Result<Option<String>>

Load a markdown file from the given category.

Source

pub async fn list_category(&self, category: &str) -> Result<Vec<String>>

List all markdown files in a category (names without extension).

Source

pub async fn save_json<T: Serialize>( &self, category: &str, name: &str, data: &T, ) -> Result<()>

Save a serializable value as JSON under the given category.

Source

pub async fn load_json<T: DeserializeOwned>( &self, category: &str, name: &str, ) -> Result<Option<T>>

Load a deserializable value from JSON in the given category.

Source

pub async fn delete_file(&self, category: &str, name: &str) -> Result<bool>

Delete a file from the given category.

Source§

impl StateStore

Source

pub async fn save_session(&self, session: &Session) -> Result<()>

Saves a session to the sessions category.

Source

pub async fn save_session_with_prune( &self, session: &Session, prune_config: &PruneConfig, ) -> Result<()>

Saves a session and then runs pruning if auto_prune is enabled.

Source

pub async fn load_session( &self, session_id: &SessionId, ) -> Result<Option<Session>>

Loads a session by ID.

Source

pub async fn list_sessions(&self) -> Result<Vec<SessionSummary>>

Lists all sessions (sorted by updated_at descending).

Source

pub async fn delete_session(&self, session_id: &SessionId) -> Result<bool>

Deletes a session by ID.

Source

pub async fn get_or_create_session( &self, user_id: &str, session_id: Option<&SessionId>, ) -> Result<Session>

Gets or creates a session for a user, initializing with the given session ID.

Source

pub async fn update_session(&self, session: &Session) -> Result<()>

Updates an existing session, saving it to disk.

Source

pub async fn prune_sessions(&self, config: &PruneConfig) -> Result<usize>

Prune sessions based on configuration.

Removes sessions that exceed TTL or exceed the maximum count. Returns the number of sessions pruned.

Trait Implementations§

Source§

impl AuditPersistence for StateStore

Source§

fn save(&self, entries: &[TrailEntry]) -> Result<()>

Save entries to persistent storage.
Source§

fn load(&self) -> Result<Vec<TrailEntry>>

Load entries from persistent storage.
Source§

impl Clone for StateStore

Source§

fn clone(&self) -> StateStore

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StateStore

Source§

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

Formats the value using the given formatter. Read more
Source§

impl MemoryStorage for StateStore

Source§

fn save_json_value<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 self, c: &'life1 str, k: &'life2 str, v: &'life3 Value, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Save a JSON value to a category/key.
Source§

fn load_json_value<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, c: &'life1 str, k: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<Option<Value>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Load a JSON value from a category/key.
Source§

fn list_category<'life0, 'life1, 'async_trait>( &'life0 self, category: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<Vec<String>>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

List all keys in a category.
Source§

fn delete_file<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, category: &'life1 str, key: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<bool>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Delete a file by category/key. Returns true if the file existed.

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

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<S> MemoryStorageExt for S
where S: MemoryStorage + ?Sized,

Source§

fn save_json<'life0, 'life1, 'life2, 'life3, 'async_trait, T>( &'life0 self, category: &'life1 str, key: &'life2 str, value: &'life3 T, ) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait, T: 'async_trait + Serialize + Send + Sync, Self: Sync + 'async_trait,

Save a typed serializable value as JSON.
Source§

fn load_json<'life0, 'life1, 'life2, 'async_trait, T>( &'life0 self, category: &'life1 str, key: &'life2 str, ) -> Pin<Box<dyn Future<Output = Result<Option<T>, Error>> + Send + 'async_trait>>
where 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, T: 'async_trait + DeserializeOwned + Send, Self: Sync + 'async_trait,

Load a typed deserializable value from JSON.
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> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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