Struct dia_args::docs::Docs[−][src]

pub struct Docs<'a> {
    pub name: Cow<'a, str>,
    pub docs: Cow<'a, str>,
    pub cfg: Cfg,
    pub i18n: I18n<'a>,
    pub options: Option<Vec<Cow<'a, Opt<'a>>>>,
    pub commands: Option<Vec<Cow<'a, Cmd<'a>>>>,
    pub project: Option<Project<'a>>,
}

Documentation

Fields

name: Cow<'a, str>

Name

docs: Cow<'a, str>

Documentation

cfg: Cfg

Configuration

i18n: I18n<'a>

Internatinonalization

options: Option<Vec<Cow<'a, Opt<'a>>>>

Options

commands: Option<Vec<Cow<'a, Cmd<'a>>>>

Commands

project: Option<Project<'a>>

Project

Implementations

impl<'a> Docs<'a>[src]

pub fn new(name: Cow<'a, str>, docs: Cow<'a, str>) -> Self[src]

Makes new instance with default configurations

pub fn print(self) -> Result<()>[src]

Prints this documentation to stdout

Trait Implementations

impl Display for Docs<'_>[src]

Auto Trait Implementations

impl<'a> !RefUnwindSafe for Docs<'a>

impl<'a> !Send for Docs<'a>

impl<'a> !Sync for Docs<'a>

impl<'a> Unpin for Docs<'a>

impl<'a> !UnwindSafe for Docs<'a>

Blanket Implementations

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

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T> ToString for T where
    T: Display + ?Sized, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.