Struct dia_args::docs::Cmd

source ·
pub struct Cmd<'a> { /* private fields */ }
Expand description

§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(...)

Implementations§

source§

impl<'a> Cmd<'a>

source

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

§Makes new instance
source

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

§Formats self

Trait Implementations§

source§

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

source§

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

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

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

source§

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

Converts to this type from the input type.
source§

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

source§

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

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<'a> Freeze for Cmd<'a>

§

impl<'a> RefUnwindSafe for Cmd<'a>

§

impl<'a> Send for Cmd<'a>

§

impl<'a> Sync for Cmd<'a>

§

impl<'a> Unpin for Cmd<'a>

§

impl<'a> UnwindSafe for Cmd<'a>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.