Struct Help

pub struct Help { /* private fields */ }

Load and parse the documentations at the SwitchBot API.

Please see Help::command_helps() for an example.

Implementations

impl Help

pub async fn load() -> Result<Self>

Loads and parses the documentations from the SwitchBot API.

pub fn command_helps(&self, device: &Device) -> &Vec<CommandHelp>

Get a list of CommandHelp for a Device. Returns an empty Vec if no CommandHelps are found.

Examples

let help = Help::load().await?;
let command_helps = help.command_helps(device);
for command_help in command_helps {
  println!("{}", command_help);
}

Trait Implementations

impl Debug for Help

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

Formats the value using the given formatter.

impl Default for Help

fn default() -> Help

Returns the “default value” for a type.