Struct dia_args::docs::Cmd

pub struct Cmd<'a> { /* fields omitted */ }

Command

Examples

use std::borrow::Cow;
use dia_args::docs::Cmd;

// All these constants are convenient while working with Args.
// And you can also use them for Cmd.

const CMD_HELP: &str = "help";
const CMD_HELP_DOCS: Cow<str> = Cow::Borrowed("Prints help and exits.");

let _cmd = Cmd::new(CMD_HELP, CMD_HELP_DOCS, None);
// Here you can pass this command to Docs::new(...)

Methods

impl<'a> Cmd<'a>

pub const fn new(
    name: &'a str,
    docs: Cow<'a, str>,
    options: Option<Vec<Cow<'a, Opt<'a>>>>
) -> Self

Makes new instance

pub fn format(
    &self,
    cfg: &Cfg,
    i18n: &I18n,
    f: &mut Formatter
) -> Result<(), Error>

Formats self

Trait Implementations

impl<'a> From<Cmd<'a>> for Cow<'a, Cmd<'a>>

fn from(cmd: Cmd<'a>) -> Self

Performs the conversion.

impl<'a> From<&'a Cmd<'a>> for Cow<'a, Cmd<'a>>

fn from(cmd: &'a Cmd<'a>) -> Self

Performs the conversion.

impl<'a> Clone for Cmd<'a>

fn clone(&self) -> Cmd<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.