Struct dia_args::docs::Opt

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

Option

Examples

use std::borrow::Cow;
use dia_args::docs::{self, 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: Cow<str> = Cow::Borrowed("Port for server.");

let _opt = Opt::new(
    ARG_PORT, false,
    Some(docs::make_cow_strings(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<Cow<'a, str>>>,
    default: Option<&'a dyn Display>,
    docs: Cow<'a, str>
) -> Self

Makes new instance

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

Formats self

Trait Implementations

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

fn from(opt: Opt<'a>) -> Self

Performs the conversion.

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

fn from(opt: &'a Opt<'a>) -> Self

Performs the conversion.

impl<'a> Clone for Opt<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.