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: QuickReferenceQuick reference
Implementations§
Source§impl HelpSystem
impl HelpSystem
Sourcepub fn get_command_help(&self, command: &str) -> Option<&CommandHelp>
pub fn get_command_help(&self, command: &str) -> Option<&CommandHelp>
Get help for a specific command.
Sourcepub fn list_commands(&self) -> Vec<&str>
pub fn list_commands(&self) -> Vec<&str>
Get all available commands.
Sourcepub fn get_usage_patterns(
&self,
category: Option<UsageCategory>,
) -> Vec<&UsagePattern>
pub fn get_usage_patterns( &self, category: Option<UsageCategory>, ) -> Vec<&UsagePattern>
Get usage patterns by category.
Sourcepub fn get_troubleshooting(&self) -> &[TroubleshootingGuide]
pub fn get_troubleshooting(&self) -> &[TroubleshootingGuide]
Get troubleshooting guides.
Sourcepub fn get_quick_reference(&self) -> &QuickReference
pub fn get_quick_reference(&self) -> &QuickReference
Get quick reference.
Sourcepub fn search(&self, query: &str) -> Vec<HelpResult>
pub fn search(&self, query: &str) -> Vec<HelpResult>
Search help content.
Sourcepub fn format_help(&self, command: Option<&str>) -> String
pub fn format_help(&self, command: Option<&str>) -> String
Format help output for display.
Sourcepub fn format_accessible_help(&self, command: Option<&str>) -> String
pub fn format_accessible_help(&self, command: Option<&str>) -> String
Generate accessible help output.
Trait Implementations§
Auto Trait Implementations§
impl Freeze for HelpSystem
impl RefUnwindSafe for HelpSystem
impl Send for HelpSystem
impl Sync for HelpSystem
impl Unpin for HelpSystem
impl UnsafeUnpin for HelpSystem
impl UnwindSafe for HelpSystem
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more