pub struct Engine { /* private fields */ }Expand description
HIPPMEM unified orchestration facade.
Holds the persistent storage, model registry, and algorithm params, and exposes seven core APIs externally.
Corresponds to 05 §0, 09 §1.
Implementations§
Source§impl Engine
impl Engine
Sourcepub fn consolidate(
&self,
scope: ConsolidationScope,
) -> EngineResult<ConsolidationReport>
pub fn consolidate( &self, scope: ConsolidationScope, ) -> EngineResult<ConsolidationReport>
Runs consolidation: Hebbian→decay→compaction→summary, covering the specified scope. Reindex scope: rebuilds all secondary indexes from memory_log (no data loss).
Source§impl Engine
impl Engine
Sourcepub fn dump(&self, input: DumpInput) -> EngineResult<DumpOutput>
pub fn dump(&self, input: DumpInput) -> EngineResult<DumpOutput>
Exports all MemoryUnit entries as JSON Lines format.
If output_path is Some, writes to a file and returns the path echo;
if None, returns the JSONL string.
Source§impl Engine
impl Engine
Sourcepub fn explain(
&self,
id: MemoryId,
_ctx: Option<RetrieveContext>,
) -> EngineResult<Explanation>
pub fn explain( &self, id: MemoryId, _ctx: Option<RetrieveContext>, ) -> EngineResult<Explanation>
Explains a memory: source/importance/connections/corrections/recent activations.
Source§impl Engine
impl Engine
Sourcepub fn feedback(&self, input: FeedbackInput) -> EngineResult<()>
pub fn feedback(&self, input: FeedbackInput) -> EngineResult<()>
Records a usage feedback signal.
The signal is persisted to activation_log for consumption by the background Hebbian/decay worker.
Source§impl Engine
impl Engine
Sourcepub fn inspect(&self, query: InspectQuery) -> EngineResult<InspectReport>
pub fn inspect(&self, query: InspectQuery) -> EngineResult<InspectReport>
Diagnostic query: StoreStats/QueueStatus, etc.
Source§impl Engine
impl Engine
Sourcepub fn list(&self, input: ListInput) -> EngineResult<ListOutput>
pub fn list(&self, input: ListInput) -> EngineResult<ListOutput>
Lists memories with pagination, fixed to NewestFirst (MemoryId descending) order.
Reads all memories from the MEMORY_KV table, filters by content_type, then returns a page.
Source§impl Engine
impl Engine
Sourcepub fn retrieve(&self, input: RetrieveInput) -> EngineResult<RetrieveOutput>
pub fn retrieve(&self, input: RetrieveInput) -> EngineResult<RetrieveOutput>
Retrieves memories: multi-channel seeds→activation energy→spreading→rerank→warnings.
Source§impl Engine
impl Engine
Sourcepub fn traverse(&self, input: TraverseInput) -> EngineResult<TraverseOutput>
pub fn traverse(&self, input: TraverseInput) -> EngineResult<TraverseOutput>
BFS graph traversal: starts from start_id and explores the memory network along association edges.
Source§impl Engine
impl Engine
Sourcepub fn write(&self, input: WriteMemoryInput) -> EngineResult<WriteMemoryOutput>
pub fn write(&self, input: WriteMemoryInput) -> EngineResult<WriteMemoryOutput>
Writes a memory.
Sourcepub fn write_batch(
&self,
inputs: Vec<WriteMemoryInput>,
) -> EngineResult<Vec<WriteMemoryOutput>>
pub fn write_batch( &self, inputs: Vec<WriteMemoryInput>, ) -> EngineResult<Vec<WriteMemoryOutput>>
Batch write: chunks calls to the embedding API, then processes each entry.
Significantly reduces API round trips compared to per-entry write (DashScope limits each batch to ≤10 entries).
Source§impl Engine
impl Engine
Sourcepub fn open(config: EngineConfig) -> EngineResult<Self>
pub fn open(config: EngineConfig) -> EngineResult<Self>
Opens/creates a HIPPMEM memory store.
Corresponds to 05 §0 Engine::open.
- Automatically creates the
store_dirparent directory. - If a redb file already exists at the specified path, opens the existing store.
- Builds the Embedder backend from
config.embedder(default deterministic 256d, constitution C5).
Sourcepub fn close(self) -> EngineResult<()>
pub fn close(self) -> EngineResult<()>
Graceful shutdown.
Corresponds to 05 §0 Engine::close.
Currently only drops the store (redb auto-flushes); in the future it will wait for background workers to exit.
Sourcepub fn set_fulltext_commit_every(&self, n: usize)
pub fn set_fulltext_commit_every(&self, n: usize)
Sets the fulltext index batch commit interval (auto commit every N entries). Only used in batch write scenarios; production defaults to per-entry commit.
Sourcepub fn flush_fulltext(&self)
pub fn flush_fulltext(&self)
Force-commits all unwritten documents in the fulltext index.
Auto Trait Implementations§
impl !Freeze for Engine
impl !RefUnwindSafe for Engine
impl !UnwindSafe for Engine
impl Send for Engine
impl Sync for Engine
impl Unpin for Engine
impl UnsafeUnpin for Engine
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
impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
impl<T> Fruit for 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> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§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);