Struct ReplScopeStack 

pub struct ReplScopeStack { /* private fields */ }

Nested REPL command-scope stack used for shell-style scoped interaction.

This is what lets the REPL stay “inside” a command family while still rendering scope labels, help targets, and history prefixes consistently.

Implementations

impl ReplScopeStack

pub fn is_root(&self) -> bool

Returns true when the REPL is at the top-level scope.

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

Pushes a new command scope onto the stack.

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

Pops the current command scope from the stack.

pub fn commands(&self) -> Vec<String>

Returns the command path represented by the current stack.

pub fn contains_command(&self, command: &str) -> bool

Returns whether the stack already contains the given command.

pub fn display_label(&self) -> Option<String>

Returns a human-readable label for the current scope path.

Examples

use osp_cli::app::ReplScopeStack;

let mut scope = ReplScopeStack::default();
assert_eq!(scope.display_label(), None);

scope.enter("theme");
scope.enter("show");
assert_eq!(scope.display_label(), Some("theme / show".to_string()));

pub fn history_prefix(&self) -> String

Returns the history prefix used for shell-backed history entries.

Examples

use osp_cli::app::ReplScopeStack;

let mut scope = ReplScopeStack::default();
scope.enter("theme");
scope.enter("show");

assert_eq!(scope.history_prefix(), "theme show ");

pub fn history_scope_prefix(&self) -> Option<String>

Returns the active history scope prefix, if the REPL is inside a shell.

Examples

use osp_cli::app::ReplScopeStack;

let mut scope = ReplScopeStack::default();
assert_eq!(scope.history_scope_prefix(), None);

scope.enter("theme");
assert_eq!(scope.history_scope_prefix(), Some("theme ".to_string()));

pub fn history_scope_label(&self) -> String

Returns the user-facing label for the current history scope.

Examples

use osp_cli::app::ReplScopeStack;

let mut scope = ReplScopeStack::default();
assert_eq!(scope.history_scope_label(), "root history");

scope.enter("theme");
scope.enter("show");
assert_eq!(scope.history_scope_label(), "theme / show shell history");

pub fn prefixed_tokens(&self, tokens: &[String]) -> Vec<String>

Prepends the active scope path unless the tokens are already scoped.

Examples

use osp_cli::app::ReplScopeStack;

let mut scope = ReplScopeStack::default();
scope.enter("theme");

assert_eq!(
    scope.prefixed_tokens(&["show".to_string(), "dracula".to_string()]),
    vec!["theme".to_string(), "show".to_string(), "dracula".to_string()]
);

pub fn help_tokens(&self) -> Vec<String>

Returns help tokens for the current scope.

Examples

use osp_cli::app::ReplScopeStack;

let mut scope = ReplScopeStack::default();
scope.enter("theme");

assert_eq!(scope.help_tokens(), vec!["theme".to_string(), "--help".to_string()]);

Trait Implementations

impl Clone for ReplScopeStack

fn clone(&self) -> ReplScopeStack

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ReplScopeStack

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

Formats the value using the given formatter.

impl Default for ReplScopeStack

fn default() -> ReplScopeStack

Returns the “default value” for a type.

impl PartialEq for ReplScopeStack

fn eq(&self, other: &ReplScopeStack) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for ReplScopeStack

impl StructuralPartialEq for ReplScopeStack