MemoryBus

Struct MemoryBus 

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

Central memory facade used by the runtime.

Implementations§

Source§

impl MemoryBus

Source

pub fn builder(config: VolatileConfig) -> MemoryBusBuilder

Creates a builder for a memory bus.

Source

pub fn volatile(&self) -> &Arc<VolatileMemory>

Returns the underlying volatile store.

Source

pub fn journal(&self) -> &Arc<dyn Journal>

Returns the configured journal.

Source

pub fn vector_store(&self) -> Option<&Arc<dyn VectorStoreClient>>

Returns the configured vector store, if present.

Source

pub async fn record(&self, record: MemoryRecord) -> MemoryResult<()>

Persists a record across all configured stores.

§Errors

Returns MemoryError when writing to the journal or vector store fails.

Source

pub async fn recent(&self, limit: usize) -> Vec<MemoryRecord>

Returns recent records from volatile memory.

Source

pub async fn journal_tail( &self, limit: usize, ) -> MemoryResult<Vec<MemoryRecord>>

Reads the tail of the journal.

§Errors

Returns MemoryError when reading or decoding entries from the journal fails.

Source

pub async fn recall(&self, query: VectorQuery) -> MemoryResult<Vec<VectorMatch>>

Queries the configured vector store.

§Errors

Returns MemoryError::MissingVectorStore when the bus was not initialised with a vector store implementation.

Source

pub async fn stats(&self) -> VolatileStats

Returns utilisation statistics for the volatile store.

Trait Implementations§

Source§

impl Clone for MemoryBus

Source§

fn clone(&self) -> MemoryBus

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

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.