Struct CompletionNode 

pub struct CompletionNode {
    pub tooltip: Option<String>,
    pub sort: Option<String>,
    pub exact_token_commits: bool,
    pub value_key: bool,
    pub value_leaf: bool,
    pub prefilled_flags: BTreeMap<String, Vec<String>>,
    pub prefilled_positionals: Vec<String>,
    pub children: BTreeMap<String, CompletionNode>,
    pub flags: BTreeMap<String, FlagNode>,
    pub args: Vec<ArgNode>,
    pub flag_hints: Option<FlagHints>,
}

One node in the immutable completion tree.

A node owns the completion contract for one resolved command scope: subcommands, flags, positional arguments, and any hidden defaults inherited through aliases or shell scope.

Fields

tooltip: Option<String>

Optional description shown alongside the node.

sort: Option<String>

Optional suggestion-order hint for command/subcommand completion.

exact_token_commits: bool

Whether an exact token should commit scope even without a trailing delimiter.

value_key: bool

This node expects the next token to be a key chosen from children.

value_leaf: bool

This node is itself a terminal value that can be suggested/accepted.

prefilled_flags: BTreeMap<String, Vec<String>>

Hidden context flags injected when this node is matched.

prefilled_positionals: Vec<String>

Fixed positional values contributed before user-provided args.

children: BTreeMap<String, CompletionNode>

Nested subcommands or value-like children.

flags: BTreeMap<String, FlagNode>

Flags visible in this command scope.

args: Vec<ArgNode>

Positional arguments accepted in this command scope.

flag_hints: Option<FlagHints>

Extra flag-name hints contributed by this node.

Implementations

impl CompletionNode

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

Sets the hidden sort key for this node.

pub fn with_child(self, name: impl Into<String>, node: CompletionNode) -> Self

Adds a child node keyed by command or value name.

Examples

use osp_cli::completion::{
    CompletionNode, ContextScope, FlagNode, SuggestionEntry, ValueType,
};

let flag = FlagNode::new()
    .tooltip("Provider")
    .flag_only()
    .multi()
    .context_only(ContextScope::Global)
    .value_type(ValueType::Path)
    .suggestions([SuggestionEntry::from("vmware")]);

let node = CompletionNode::default()
    .sort("01")
    .with_child("status", CompletionNode::default())
    .with_flag("--provider", flag.clone());

assert_eq!(flag.tooltip.as_deref(), Some("Provider"));
assert!(flag.flag_only);
assert!(flag.multi);
assert!(flag.context_only);
assert_eq!(flag.context_scope, ContextScope::Global);
assert_eq!(flag.value_type, Some(ValueType::Path));
assert_eq!(flag.suggestions.len(), 1);
assert_eq!(node.sort.as_deref(), Some("01"));
assert!(node.children.contains_key("status"));
assert_eq!(node.flags.get("--provider"), Some(&flag));

pub fn with_flag(self, name: impl Into<String>, node: FlagNode) -> Self

Adds a flag node keyed by its spelling.

Trait Implementations

impl Clone for CompletionNode

fn clone(&self) -> CompletionNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CompletionNode

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

Formats the value using the given formatter.

impl Default for CompletionNode

fn default() -> CompletionNode

Returns the “default value” for a type.

impl PartialEq for CompletionNode

fn eq(&self, other: &CompletionNode) -> 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 CompletionNode

impl StructuralPartialEq for CompletionNode