Skip to main content

SharedState

Struct SharedState 

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

Shared state: a heterogeneous container accessed by type.

Type is the key: a second insert of the same type overwrites; retrieval takes a type parameter (compile-time type safety). Unlike Box<dyn Any>’s “store anything”, this container holds multiple values side by side, distinguished by type.

An internal RwLock (read-heavy) provides cross-thread safety; Clone is cheap (Arc), so tools and agents — several agents — share the same instance.

§Example

use molo::SharedState;

#[derive(Debug, Clone, PartialEq)]
struct Session { user: String }

let state = SharedState::new();
state.insert(Session { user: "alice".into() });
state.with::<Session>(|s| assert_eq!(s.user, "alice"));
state.with_mut::<Session>(|s| s.user = "bob".into());
assert_eq!(state.get::<Session>(), Some(Session { user: "bob".into() }));

Implementations§

Source§

impl SharedState

Source

pub fn new() -> Self

An empty shared state.

Source

pub fn insert<T: Any + Send + Sync>(&self, value: T)

Store a custom value; storing the same type again overwrites.

Source

pub fn get<T: Any + Clone>(&self) -> Option<T>

Retrieve (clone) a custom value; returns None when the type is absent (the type must implement Clone; a clone is returned and the original value in the container is unchanged).

Source

pub fn with<T: Any>(&self, f: impl FnOnce(&T))

Read an existing value under the lock; the closure does not run when the type is absent.

§Panics

A panic inside the closure propagates outward; the lock gets poisoned as a result, but the container recovers from poisoning and later access works as usual (the closure returns nothing; for an in-place read use get).

§Deadlock red line

The underlying RwLock is not reentrant, and the closure runs while the lock is held: the closure must not access the same SharedState again (e.g. with(|a| ... state.get::<B>() ...)), or it hangs with no error. To access several values at once, call get sequentially / combine them into one struct, or move reads and writes outside the closure.

Source

pub fn with_mut<T: Any>(&self, f: impl FnOnce(&mut T))

Update an existing value in place under the lock; the closure does not run when the type is absent.

§Panics

A panic inside the closure propagates outward; the lock gets poisoned as a result, but the container recovers from poisoning and later access works as usual.

§Deadlock red line

Same as with: the underlying lock is not reentrant, and the closure must not access the same SharedState again.

Trait Implementations§

Source§

impl Clone for SharedState

Source§

fn clone(&self) -> SharedState

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 SharedState

Source§

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

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

impl Default for SharedState

Source§

fn default() -> SharedState

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