Struct SoulProvider 

pub struct SoulProvider {
    pub source: SoulSource,
    /* private fields */
}

Loads an agent identity from a Markdown soul file and injects it as a frozen system-prompt block.

Resolution order (first non-empty file wins):

1. Explicit path in [memory] soul_file = "..." config
2. .newt/soul.md in the current workspace
3. ~/.newt/soul.md (global user soul)
4. Built-in default identity

The soul is read once at initialize() and frozen — mid-session writes don’t rebuild the system prompt (preserves the KV/prefix cache).

Fields

source: SoulSource

Resolved path of the soul that was actually loaded (for display).

Implementations

impl SoulProvider

pub fn new(override_path: Option<PathBuf>) -> Self

Create with an optional explicit override path (from config).

pub fn from_config() -> Self

Create from config, reading [memory] soul_file if present.

pub fn load(&mut self, workspace: &str)

Resolve and load the soul for workspace. Called from initialize.

Trait Implementations

impl MemoryProvider for SoulProvider

fn system_prompt_block(&self) -> Option<String>

Return the frozen soul as the system prompt base.

fn name(&self) -> &str

Short stable identifier, e.g. "rolling_window".

fn initialize<'life0, 'life1, 'async_trait>( &'life0 mut self, ctx: &'life1 SessionContext, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

One-time setup at session start (load files, warm caches, etc.). Default: no-op.

fn build_messages( &self, _system_prompt: &str, _new_task: &str, ) -> Vec<MemMessage>

Build the full message list (including history) to send to the model.

fn sync_turn<'life0, 'life1, 'life2, 'life3, 'async_trait>( &'life0 mut self, _user: &'life1 str, _assistant: &'life2 str, _metrics: &'life3 TurnMetrics, ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait, 'life3: 'async_trait,

Persist a completed turn.

fn prefetch<'life0, 'life1, 'async_trait>( &'life0 self, _query: &'life1 str, ) -> Pin<Box<dyn Future<Output = Result<String>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Recall relevant context to prepend to the user turn before the API call. Should be fast — use cached results, don’t block. Return empty string to contribute nothing.

fn reset(&mut self)

Clear conversation-local history while preserving provider configuration and system-prompt state. Used when the TUI starts a fresh conversation inside the same running process.

fn restore_turns(&mut self, _turns: &[ConversationTurn])

Replace conversation-local history with durable restored turns.

fn take_compaction_record(&mut self) -> Option<String>

Take (and clear) the compaction record minted since the last call — the full marked summary message a compressing provider inserted into its working set (Step 18.5, #247). The caller persists it as a turn record (user = the marked message, assistant = empty, token columns NULL — it is not a backend-measured turn) so a later restore can rehydrate the same working-set shape via Self::restore_turns. Default: None — providers that never compress mint nothing.

fn on_pre_compress<'life0, 'life1, 'async_trait>( &'life0 self, _messages: &'life1 [MemMessage], ) -> Pin<Box<dyn Future<Output = String> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called before old messages are discarded (e.g. during compression). Extract anything worth keeping from messages; return it as a string to include in the compression summary. Return empty string for nothing.

fn on_session_end<'life0, 'life1, 'async_trait>( &'life0 mut self, _messages: &'life1 [MemMessage], ) -> Pin<Box<dyn Future<Output = ()> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Called once when the session ends. Use for final extraction / cleanup.

fn usage(&self) -> Option<(String, usize, usize)>

Report current usage for display (e.g. /memory command). Returns (label, current, max) — e.g. ("turns", 12, 20).

fn add_note(&mut self, _fact: &str) -> Result<()>

Add a persistent note.

fn replace_note(&mut self, _old_substring: &str, _new_text: &str) -> Result<()>

Replace the single persisted note containing old_substring with new_text (Step 19.3 — the save_note tool’s replace action). Default: NotesUnsupported, same routing contract as add_note.

fn remove_note(&mut self, _substring: &str) -> Result<()>

Remove the single persisted note containing substring (Step 19.3 — the save_note tool’s remove action). Default: NotesUnsupported, same routing contract as add_note.