pub struct PersistentMemory { /* private fields */ }Expand description
Write-through memory that persists turns to a MemoryStore and caches them in-process.
Implementations§
Source§impl PersistentMemory
impl PersistentMemory
Sourcepub fn new(
session_id: impl Into<String>,
app_name: impl Into<String>,
user_id: impl Into<String>,
store: Arc<dyn MemoryStore>,
) -> Self
pub fn new( session_id: impl Into<String>, app_name: impl Into<String>, user_id: impl Into<String>, store: Arc<dyn MemoryStore>, ) -> Self
Unbounded persistent memory.
Sourcepub fn windowed(
session_id: impl Into<String>,
app_name: impl Into<String>,
user_id: impl Into<String>,
store: Arc<dyn MemoryStore>,
n: usize,
) -> Self
pub fn windowed( session_id: impl Into<String>, app_name: impl Into<String>, user_id: impl Into<String>, store: Arc<dyn MemoryStore>, n: usize, ) -> Self
Windowed persistent memory — only the last n turns are kept in the in-process cache.
Older turns are still in the backing store but won’t be injected into prompts.
Sourcepub async fn hydrate(&mut self) -> Result<(), StoreError>
pub async fn hydrate(&mut self) -> Result<(), StoreError>
Load all turns from the backing store into the in-process cache. Idempotent — subsequent calls are no-ops once hydrated.
Sourcepub async fn push_turn_async(
&mut self,
turn: MemoryTurn,
) -> Result<(), StoreError>
pub async fn push_turn_async( &mut self, turn: MemoryTurn, ) -> Result<(), StoreError>
Append a turn to the cache and persist it to the backing store.
Sourcepub async fn clear_store(&mut self) -> Result<(), StoreError>
pub async fn clear_store(&mut self) -> Result<(), StoreError>
Clear the in-process cache and delete all turns from the backing store.
Trait Implementations§
Source§impl Debug for PersistentMemory
impl Debug for PersistentMemory
Source§impl Memory for PersistentMemory
impl Memory for PersistentMemory
Source§fn push_turn(&mut self, turn: MemoryTurn)
fn push_turn(&mut self, turn: MemoryTurn)
Synchronous push — appends to the in-process cache only.
Note: this does not persist to the backing store. Use push_turn_async in async
contexts to ensure write-through persistence.
Source§fn as_any_mut(&mut self) -> Option<&mut dyn Any>
fn as_any_mut(&mut self) -> Option<&mut dyn Any>
PersistentMemory).
Override in concrete types to support downcast_mut.Source§fn messages(&self) -> Vec<MessageNum>
fn messages(&self) -> Vec<MessageNum>
fn clear(&mut self)
fn len(&self) -> usize
fn is_empty(&self) -> bool
Auto Trait Implementations§
impl Freeze for PersistentMemory
impl !RefUnwindSafe for PersistentMemory
impl Send for PersistentMemory
impl Sync for PersistentMemory
impl Unpin for PersistentMemory
impl UnsafeUnpin for PersistentMemory
impl !UnwindSafe for PersistentMemory
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);