Skip to main content

StateManager

Struct StateManager 

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

A helper for managing state and generating deltas.

StateManager tracks the current state and provides methods to update it while automatically computing the JSON Patch delta between states. This is useful for efficiently synchronizing state with frontends.

§Example

use ag_ui_core::state::StateManager;
use serde_json::json;

let mut manager = StateManager::new(json!({"count": 0, "items": []}));

// Update state - returns delta patch
let delta = manager.update(json!({"count": 1, "items": []}));
assert!(delta.is_some());

// No change - returns None
let delta = manager.update(json!({"count": 1, "items": []}));
assert!(delta.is_none());

// Check current state
assert_eq!(manager.current()["count"], 1);

Implementations§

Source§

impl StateManager

Source

pub fn new(initial: JsonValue) -> Self

Creates a new state manager with the given initial state.

Source

pub fn current(&self) -> &JsonValue

Returns a reference to the current state.

Source

pub fn version(&self) -> u64

Returns the current state version (increments on each update).

Source

pub fn update(&mut self, new_state: JsonValue) -> Option<Patch>

Updates the state and returns the delta patch if there were changes.

Returns None if the new state is identical to the current state.

Source

pub fn update_with<F>(&mut self, f: F) -> Option<Patch>
where F: FnOnce(&mut JsonValue),

Updates the state using a closure and returns the delta patch.

The closure receives a mutable reference to the current state. After the closure completes, the delta is computed.

§Example
use ag_ui_core::state::StateManager;
use serde_json::json;

let mut manager = StateManager::new(json!({"count": 0}));

let delta = manager.update_with(|state| {
    state["count"] = json!(10);
});

assert!(delta.is_some());
assert_eq!(manager.current()["count"], 10);
Source

pub fn reset(&mut self, new_state: JsonValue)

Resets the state to a new value without computing a delta.

Use this when you want to replace the entire state (e.g., on reconnection) and will send a snapshot instead of a delta.

Source

pub fn snapshot(&self) -> JsonValue

Takes a snapshot of the current state.

Returns a clone of the current state value.

Trait Implementations§

Source§

impl Clone for StateManager

Source§

fn clone(&self) -> StateManager

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for StateManager

Source§

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

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

impl Default for StateManager

Source§

fn default() -> Self

Returns the “default value” for a type. 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> 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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