Struct dia_args::docs::Option

pub struct Option<'a> { /* private fields */ }

Option

Examples

use std::borrow::Cow;
use dia_args::docs::{self, Option};

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

const OPTION_PORT: &[&str] = &["-p", "--port"];
const OPTION_PORT_VALUES: &[u16] = &[0, 64009];
const OPTION_PORT_DEFAULT: u16 = OPTION_PORT_VALUES[1];
const OPTION_PORT_DOCS: Cow<str> = Cow::Borrowed("Port for server.");

let _option = Option::new(
    OPTION_PORT, false,
    OPTION_PORT_VALUES,
    Some(OPTION_PORT_DEFAULT),
    OPTION_PORT_DOCS,
);
// Here you can pass this option to Docs::new(...)

Implementations

impl<'a> Option<'a>

pub fn new<T>( names: &'a [&'a str], required: bool, values: &[T], default: RustOption<T>, docs: Cow<'a, str> ) -> Self

where T: Display,

Makes new instance

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

Formats self

Trait Implementations

impl<'a> Clone for Option<'a>

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

Returns a copy of the value.

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

Performs copy-assignment from source.

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

fn from(option: &'a Option<'a>) -> Self

Converts to this type from the input type.

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

fn from(option: Option<'a>) -> Self

Converts to this type from the input type.