Struct dia_args::docs::Opt

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

Option

Examples

use dia_args::docs::Opt;

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

const ARG_PORT: &[&str] = &["-p", "--port"];
const ARG_PORT_VALUES: &[u16] = &[0, 64009];
const ARG_PORT_DEFAULT: u16 = ARG_PORT_VALUES[1];
const ARG_PORT_DOCS: &str = "Port for server.";

let _opt = Opt::new(
    ARG_PORT, false, Some(dia_args::display!(ARG_PORT_VALUES)), Some(&ARG_PORT_DEFAULT),
    ARG_PORT_DOCS,
);
// Here you can pass this option to Docs::new(...)

Methods

impl<'a> Opt<'a>

pub fn new(
    names: &'a [&'a str],
    required: bool,
    values: Option<Vec<&'a dyn Display>>,
    default: Option<&'a dyn Display>,
    docs: &'a str
) -> Self

Makes new instance

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

Formats self