Struct AppSession 

#[non_exhaustive]
pub struct AppSession {
    pub prompt_prefix: String,
    pub history_enabled: bool,
    pub history_shell: HistoryShellContext,
    pub prompt_timing: DebugTimingState,
    pub scope: ReplScopeStack,
    pub last_rows: Vec<Row>,
    pub last_failure: Option<LastFailure>,
    pub result_cache: HashMap<String, Vec<Row>>,
    pub cache_order: VecDeque<String>,
    pub max_cached_results: usize,
    pub config_overrides: ConfigLayer,
    /* private fields */
}

Session-scoped REPL state, caches, and prompt metadata.

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.

prompt_prefix: String

Prompt prefix shown before any scope label.

history_enabled: bool

Whether history capture is enabled for this session.

history_shell: HistoryShellContext

Shell-scoped history prefix state shared with the history store.

prompt_timing: DebugTimingState

Shared prompt timing badge state.

scope: ReplScopeStack

Current nested command scope within the REPL.

last_rows: Vec<Row>

Rows returned by the most recent successful REPL command.

last_failure: Option<LastFailure>

Summary of the most recent failed REPL command.

result_cache: HashMap<String, Vec<Row>>

Cached row outputs keyed by command line.

cache_order: VecDeque<String>

Eviction order for the row-result cache.

max_cached_results: usize

Maximum number of cached result sets to retain.

config_overrides: ConfigLayer

Session-scoped config overrides layered above persisted config.

Implementations

impl AppSession

pub fn builder() -> AppSessionBuilder

Starts the builder for session-scoped host state.

Prefer this when you want a neutral starting point and do not want the first constructor call to imply that cache sizing is the primary concern.

Examples

use osp_cli::app::AppSession;

let session = AppSession::builder()
    .with_prompt_prefix("demo")
    .with_history_enabled(false)
    .build();

assert_eq!(session.prompt_prefix, "demo");
assert!(!session.history_enabled);

pub fn with_cache_limit(max_cached_results: usize) -> Self

Creates a session with bounded caches for row and command results.

A requested cache limit of 0 is clamped to 1 so the session never stores a zero-capacity cache by accident.

Examples

use osp_cli::app::AppSession;

let session = AppSession::with_cache_limit(4).with_prompt_prefix("demo");

assert_eq!(session.max_cached_results, 4);
assert_eq!(session.prompt_prefix, "demo");

pub fn with_prompt_prefix(self, prompt_prefix: impl Into<String>) -> Self

Replaces the prompt prefix shown ahead of any scope label.

pub fn with_history_enabled(self, history_enabled: bool) -> Self

Enables or disables history capture for this session.

pub fn with_history_shell(self, history_shell: HistoryShellContext) -> Self

Replaces the shell-scoped history context shared with the history store.

pub fn with_config_overrides(self, config_overrides: ConfigLayer) -> Self

Replaces the session-scoped config overrides layered above persisted config.

pub fn enter_repl_scope(&mut self, command: impl Into<String>)

Enters a nested REPL shell scope and synchronizes history context.

pub fn leave_repl_scope(&mut self) -> Option<ReplScopeFrame>

Leaves the current REPL shell scope and synchronizes history context.

pub fn record_result(&mut self, command_line: &str, rows: Vec<Row>)

Stores the latest successful row output and updates the result cache.

pub fn record_failure( &mut self, command_line: &str, summary: impl Into<String>, detail: impl Into<String>, )

Records details about the latest failed command.

pub fn cached_rows(&self, command_line: &str) -> Option<&[Row]>

Returns cached rows for a previously executed command line.

pub fn record_prompt_timing( &self, level: u8, total: Duration, parse: Option<Duration>, execute: Option<Duration>, render: Option<Duration>, )

Updates the prompt timing badge for the most recent command.

pub fn seed_startup_prompt_timing(&mut self, level: u8, total: Duration)

Seeds the initial prompt timing badge emitted during startup.

pub fn sync_history_shell_context(&self)

Synchronizes history context with the current REPL scope.

Trait Implementations

impl Default for AppSession

fn default() -> Self

Returns the “default value” for a type.