CoreMemory

Struct CoreMemory 

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

Core memory - always in LLM context.

TigerStyle:

  • Fixed capacity (~32KB)
  • One block per type (type-indexed)
  • Deterministic render order
  • Explicit size tracking

§Example

use umi_memory::memory::{CoreMemory, MemoryBlockType};

let mut core = CoreMemory::new();
core.set_block(MemoryBlockType::System, "You are helpful.").unwrap();
core.set_block(MemoryBlockType::Human, "User: Alice").unwrap();

assert!(core.used_bytes() > 0);
let context = core.render();
assert!(context.contains("You are helpful."));

Implementations§

Source§

impl CoreMemory

Source

pub fn new() -> Self

Create a new core memory with default configuration.

Source

pub fn with_config(config: CoreMemoryConfig) -> Self

Create a new core memory with custom configuration.

Source

pub fn set_clock_ms(&mut self, ms: u64)

Set the internal clock (for DST).

TigerStyle: Explicit time control for simulation.

Source

pub fn clock_ms(&self) -> u64

Get the internal clock value.

Source

pub fn set_block( &mut self, block_type: MemoryBlockType, content: impl Into<String>, ) -> Result<MemoryBlockId, CoreMemoryError>

Set a block by type.

If a block of this type already exists, it is replaced. The old block’s size is reclaimed.

§Errors

Returns error if the content is too large or would exceed capacity.

Source

pub fn set_block_with_label( &mut self, block_type: MemoryBlockType, label: impl Into<String>, content: impl Into<String>, ) -> Result<MemoryBlockId, CoreMemoryError>

Set a block with a label.

§Errors

Returns error if content/label too large or would exceed capacity.

Source

pub fn get_block(&self, block_type: MemoryBlockType) -> Option<&MemoryBlock>

Get a block by type.

Source

pub fn get_content(&self, block_type: MemoryBlockType) -> Option<&str>

Get block content by type.

Source

pub fn has_block(&self, block_type: MemoryBlockType) -> bool

Check if a block type exists.

Source

pub fn remove_block( &mut self, block_type: MemoryBlockType, ) -> Result<MemoryBlock, CoreMemoryError>

Remove a block by type.

§Errors

Returns error if block doesn’t exist.

Source

pub fn clear(&mut self)

Clear all blocks.

Source

pub fn block_count(&self) -> usize

Get the number of blocks.

Source

pub fn used_bytes(&self) -> usize

Get used bytes.

Source

pub fn available_bytes(&self) -> usize

Get available bytes.

Source

pub fn max_bytes(&self) -> usize

Get max bytes.

Source

pub fn utilization(&self) -> f64

Get utilization as a fraction (0.0 to 1.0).

Source

pub fn is_empty(&self) -> bool

Check if core memory is empty.

Source

pub fn blocks_ordered(&self) -> impl Iterator<Item = &MemoryBlock>

Iterate over blocks in render order.

TigerStyle: Deterministic ordering by block type priority.

Source

pub fn render(&self) -> String

Render core memory as XML for LLM context.

TigerStyle: Deterministic, predictable output format.

§Example Output
<core_memory>
<block type="system">
You are a helpful assistant.
</block>
<block type="human">
User prefers concise responses.
</block>
</core_memory>
Source

pub fn config(&self) -> &CoreMemoryConfig

Get configuration.

Trait Implementations§

Source§

impl Debug for CoreMemory

Source§

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

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

impl Default for CoreMemory

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