Struct SubcommandMap 

pub struct SubcommandMap { /* private fields */ }

Map of subcommand patterns to their entries. Patterns are space-separated strings (e.g. "pr create") matched via longest_match.

Deserialization validates that every pattern key respects MAX_SUBCOMMAND_DEPTH — patterns with more words are rejected at parse time with a clear error naming the offending key. Nested SubcommandEntry maps are validated recursively because SubcommandEntry::subcommands is itself a SubcommandMap.

Implementations

impl SubcommandMap

pub fn new() -> Self

pub fn insert(&mut self, pattern: impl Into<String>, entry: SubcommandEntry)

Insert a subcommand pattern and its entry.

Panics (debug builds)

Debug-asserts that the pattern does not exceed MAX_SUBCOMMAND_DEPTH. The deserialization path validates this invariant at parse time, so patterns from TOML config are always safe. This assert catches mistakes in programmatic construction during development.

pub fn get(&self, pattern: &str) -> Option<&SubcommandEntry>

pub fn is_empty(&self) -> bool

pub fn iter(&self) -> impl Iterator<Item = (&str, &SubcommandEntry)>

pub fn extend(&mut self, other: SubcommandMap)

pub fn remove(&mut self, pattern: &str)

pub fn len(&self) -> usize

pub fn longest_match( &self, words: &[&Word], ) -> Option<(&SubcommandEntry, usize)>

Trait Implementations

impl Clone for SubcommandMap

fn clone(&self) -> SubcommandMap

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SubcommandMap

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

Formats the value using the given formatter.

impl Default for SubcommandMap

fn default() -> SubcommandMap

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for SubcommandMap

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> IntoIterator for &'a SubcommandMap

type Item = (&'a str, &'a SubcommandEntry)

The type of the elements being iterated over.

type IntoIter = Map<Iter<'a, String, SubcommandEntry>, fn((&'a String, &'a SubcommandEntry)) -> (&'a str, &'a SubcommandEntry)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl Serialize for SubcommandMap

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.