Enum HelpTopic 

pub enum HelpTopic {
    Overview,
    Syntax,
    Builtins,
    Vfs,
    Scatter,
    Ignore,
    OutputLimit,
    Limits,
    Overlay,
    Tool(String),
}

Help topics available in kaish.

Variants

Overview

Overview of kaish with topic list.

Syntax

Syntax reference: variables, quoting, pipes, control flow.

Builtins

List of all available builtins.

Vfs

Virtual filesystem mounts and paths.

Scatter

Scatter/gather parallel processing.

Ignore

Ignore file configuration.

OutputLimit

Output size limit configuration.

Limits

Known limitations.

Overlay

Overlay VFS mode and kaish-vfs builtin.

Tool(String)

Help for a specific tool.

Implementations

impl HelpTopic

pub fn parse_topic(s: &str) -> Self

Parse a topic string into a HelpTopic.

Returns Overview for empty/None, specific topics for known names, or Tool(name) for anything else (assumes it’s a tool name).

pub fn description(&self) -> &'static str

Get a short description of this topic.

Trait Implementations

impl Clone for HelpTopic

fn clone(&self) -> HelpTopic

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HelpTopic

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

Formats the value using the given formatter.

impl Eq for HelpTopic

impl PartialEq for HelpTopic

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