Struct mithril_doc::FieldDoc

pub struct FieldDoc {
    pub parameter: String,
    pub command_line_long: String,
    pub command_line_short: String,
    pub environment_variable: Option<String>,
    pub description: String,
    pub default_value: Option<String>,
    pub example: Option<String>,
    pub is_mandatory: bool,
}

Information to document a field

Fields

parameter: String

Name of the parameter

command_line_long: String

Long option for the command line

command_line_short: String

Short option for the command line

environment_variable: Option<String>

Environment variable

description: String

Description of the parameter

default_value: Option<String>

Default value

example: Option<String>

Usage example

is_mandatory: bool

Is a mandatory parameter

Trait Implementations

impl Clone for FieldDoc

fn clone(&self) -> FieldDoc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FieldDoc

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for FieldDoc

fn default() -> FieldDoc

Returns the “default value” for a type.