Struct ArgNode 

pub struct ArgNode {
    pub name: Option<String>,
    pub tooltip: Option<String>,
    pub multi: bool,
    pub value_type: Option<ValueType>,
    pub suggestions: Vec<SuggestionEntry>,
}

Positional argument definition for one command slot.

This is declarative completion metadata, not parser state. One ArgNode says what a command slot expects once command-path resolution has reached the owning node.

Fields

name: Option<String>

Argument name shown in completion UIs.

tooltip: Option<String>

Optional description shown alongside the argument.

multi: bool

Whether the argument may consume multiple values.

value_type: Option<ValueType>

Semantic type for the argument value.

suggestions: Vec<SuggestionEntry>

Suggested values for the argument.

Implementations

impl ArgNode

pub fn named(name: impl Into<String>) -> Self

Creates an argument node with a visible argument name.

Examples

use osp_cli::completion::{ArgNode, SuggestionEntry, ValueType};

let entry = SuggestionEntry::value("alma")
    .meta("linux")
    .display("AlmaLinux")
    .sort("02");
let arg = ArgNode::named("image")
    .tooltip("Image name")
    .multi()
    .value_type(ValueType::Path)
    .suggestions([entry.clone()]);

assert_eq!(entry.meta.as_deref(), Some("linux"));
assert_eq!(entry.display.as_deref(), Some("AlmaLinux"));
assert_eq!(entry.sort.as_deref(), Some("02"));
assert_eq!(arg.name.as_deref(), Some("image"));
assert_eq!(arg.tooltip.as_deref(), Some("Image name"));
assert!(arg.multi);
assert_eq!(arg.value_type, Some(ValueType::Path));
assert_eq!(arg.suggestions, vec![entry]);

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

Sets the display tooltip for this argument.

If omitted, completion UIs show no description for this argument.

pub fn multi(self) -> Self

Marks this argument as accepting multiple values.

If omitted, the argument accepts a single value.

pub fn value_type(self, value_type: ValueType) -> Self

Sets the semantic value type for this argument.

If omitted, the argument carries no special value-type hint.

pub fn suggestions( self, suggestions: impl IntoIterator<Item = SuggestionEntry>, ) -> Self

Replaces the suggestion list for this argument.

If omitted, the argument contributes no direct value suggestions.

Trait Implementations

impl Clone for ArgNode

fn clone(&self) -> ArgNode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ArgNode

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

Formats the value using the given formatter.

impl Default for ArgNode

fn default() -> ArgNode

Returns the “default value” for a type.

impl PartialEq for ArgNode

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

impl StructuralPartialEq for ArgNode