Skip to main content

HelpSystem

Struct HelpSystem 

Source
pub struct HelpSystem {
    pub commands: HashMap<String, CommandHelp>,
    pub usage_patterns: Vec<UsagePattern>,
    pub troubleshooting: Vec<TroubleshootingGuide>,
    pub quick_reference: QuickReference,
}
Expand description

Comprehensive help system for Sprite commands and features.

Fields§

§commands: HashMap<String, CommandHelp>

Command documentation

§usage_patterns: Vec<UsagePattern>

Common usage patterns

§troubleshooting: Vec<TroubleshootingGuide>

Troubleshooting guides

§quick_reference: QuickReference

Quick reference

Implementations§

Source§

impl HelpSystem

Source

pub fn new() -> Self

Create a new help system with all documentation.

Source

pub fn get_command_help(&self, command: &str) -> Option<&CommandHelp>

Get help for a specific command.

Source

pub fn list_commands(&self) -> Vec<&str>

Get all available commands.

Source

pub fn get_usage_patterns( &self, category: Option<UsageCategory>, ) -> Vec<&UsagePattern>

Get usage patterns by category.

Source

pub fn get_troubleshooting(&self) -> &[TroubleshootingGuide]

Get troubleshooting guides.

Source

pub fn get_quick_reference(&self) -> &QuickReference

Get quick reference.

Source

pub fn search(&self, query: &str) -> Vec<HelpResult>

Search help content.

Source

pub fn format_help(&self, command: Option<&str>) -> String

Format help output for display.

Source

pub fn format_accessible_help(&self, command: Option<&str>) -> String

Generate accessible help output.

Trait Implementations§

Source§

impl Clone for HelpSystem

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for HelpSystem

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for HelpSystem

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl Display for HelpSystem

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> ErasedDestructor for T
where T: 'static,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more