Struct MemoryConfig 

#[non_exhaustive]
pub struct MemoryConfig {

    pub policy: WritePolicy,
    pub commit_each_turn: bool,
    pub default_tags: Vec<String>,
    pub scope: Option<String>,
    pub principal: Option<String>,
    pub persist_assistant: bool,
    pub supplemental_profile_cards: bool,
    pub auto_tag: bool,
    pub extract_dates: bool,
    pub extract_triplets: bool,
    pub observe_conversation_id: Option<String>,
    pub on_write_failure: WriteFailure,
    pub rewrite_principal_pronouns: bool,
}

Configuration for MemvidPersistHook.

MemoryConfig is #[non_exhaustive] so new fields can be added without a SemVer-major bump; build instances through MemoryConfig::default + field updates, or through MemoryConfig::builder for a fluent shape.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

policy: WritePolicy

What to persist on each turn.

commit_each_turn: bool

If true, call commit() after every turn so the new frames are immediately searchable. If false, the caller is responsible for committing periodically.

default_tags: Vec<String>

Tags applied to every persisted frame, useful for later filtering.

scope: Option<String>

Logical scope written into the frame’s URI prefix. When set, every frame produced by this hook is stored with PutOptions.uri = Some(scope), which makes MemvidFilter::eq("scope", scope) match those frames at query time (memvid’s scope is a URI prefix filter).

principal: Option<String>

Stable identity for the human side of the conversation.

When set, user turns are lightly rewritten before memvid sees them so first-person pronouns resolve to this principal. For example, with principal = Some("Alice".into()), I like espresso is persisted as Alice likes espresso. This improves memvid’s entity / slot / value extraction without requiring an LLM or a new runtime dependency.

persist_assistant: bool

If true, persist assistant responses as well as user turns.

Defaults to true to preserve the full conversation transcript. Set to false when the archive is primarily used for user profile memory and assistant paraphrases would add noisy duplicate cards.

supplemental_profile_cards: bool

Add small deterministic cards for principal-bound user turns when memvid’s built-in triplet extractor misses common user-profile or relationship facts.

Currently covers allergy / avoidance statements and simple manager / reporting statements after Self::principal has bound first-person pronouns to the stable entity. Defaults to true; it is a no-op when principal is None.

auto_tag: bool

Run memvid’s auto-tagger over each persisted frame to attach extracted entity / topic tags. Defaults to true, mirroring memvid_core::PutOptions::default.

extract_dates: bool

Run memvid’s date extractor over each persisted frame so dates mentioned in conversation become queryable. Defaults to true.

extract_triplets: bool

Extract Subject-Predicate-Object triplets from each persisted frame and store them as memvid_core::MemoryCards on the memories track. Cards become queryable through crate::MemvidStore::entity_memories, crate::MemvidStore::current_memory, crate::MemvidStore::entity_preferences, and the rest of the memory-card surface. Defaults to true.

observe_conversation_id: Option<String>

Conversation ID stamped on rig_tap events emitted by this hook (memory.frame_written). When None, the hook falls back to Self::scope and finally to "default" so existing consumers keep working, but explicitly setting this field is preferred: it decouples telemetry correlation from memvid’s URI-prefix scope. No effect when the observe feature is off.

on_write_failure: WriteFailure

What to do when a frame fails to write. Defaults to WriteFailure::Warn (log + continue) to preserve pre-0.2 behaviour. Switch to WriteFailure::Halt when durable memory is a hard requirement, or supply a WriteFailure::Custom callback to route the failure into your own metrics / alerting.

rewrite_principal_pronouns: bool

Whether to rewrite first-person pronouns in user turns into the configured Self::principal (English-only heuristic). Defaults to true, but the rewrite is also a no-op when principal is None. Set to false to disable the heuristic entirely (e.g. for non-English transcripts or when callers already canonicalise text upstream).

The rewrite also short-circuits on a per-text basis when the turn contains a triple-backtick code fence or a balanced double-quoted span containing the standalone token I; both are strong signals that the literal I is quoted speech or code and must not be rewritten.

Implementations

impl MemoryConfig

pub fn builder() -> MemoryConfigBuilder

Start a MemoryConfigBuilder for fluent construction. Equivalent to MemoryConfigBuilder::default() but easier to discover.

Trait Implementations

impl Clone for MemoryConfig

fn clone(&self) -> MemoryConfig

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for MemoryConfig

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

Formats the value using the given formatter.

impl Default for MemoryConfig

fn default() -> Self

Returns the “default value” for a type.