Struct StateUpdateHandle

pub struct StateUpdateHandle<S>
where
    S: Send + Sync + Clone + 'static,
{ /* private fields */ }

A handle that allows external code to update the application state without having direct access to the router.

Implementations

impl<S> StateUpdateHandle<S>

where S: Send + Sync + Clone + 'static,

pub fn new(sender: Sender<Box<dyn FnOnce(&mut S) + Send + 'static>>) -> Self

Create a new state update handle

pub async fn update<F>(&self, updater: F) -> Result<(), StateUpdateError>

where F: FnOnce(&mut S) + Send + 'static,

Update the application state using a closure

This allows external components to modify the shared state safely. The update is queued and applied asynchronously by the router.

Example

// Update a counter in the state
state_handle.update(|state: &mut MyAppState| {
    state.counter += 1;
}).await?;

// Update database connection pool size
state_handle.update(|state: &mut MyAppState| {
    state.config.max_db_connections = 50;
}).await?;

pub fn try_update<F>(&self, updater: F) -> Result<(), StateUpdateError>

where F: FnOnce(&mut S) + Send + 'static,

Attempt to update the state without blocking

Returns an error if the update channel is full or closed.

Trait Implementations

impl<S> Clone for StateUpdateHandle<S>

where S: Send + Sync + Clone + 'static + Clone,

fn clone(&self) -> StateUpdateHandle<S>

Returns a duplicate of the value.

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

Performs copy-assignment from source.