Struct Spec

pub struct Spec {
    pub name: String,
    pub bin: String,
    pub cmd: SpecCommand,
    pub config: SpecConfig,
    pub version: Option<String>,
    pub usage: String,
    pub complete: IndexMap<String, SpecComplete>,
    pub author: Option<String>,
    pub about: Option<String>,
    pub about_long: Option<String>,
    pub about_md: Option<String>,
    pub disable_help: Option<bool>,
}

Fields

name: String

bin: String

cmd: SpecCommand

config: SpecConfig

version: Option<String>

usage: String

complete: IndexMap<String, SpecComplete>

author: Option<String>

about: Option<String>

about_long: Option<String>

about_md: Option<String>

disable_help: Option<bool>

Implementations

impl Spec

pub fn parse_file(file: &Path) -> Result<(Spec, String), UsageErr>

pub fn parse_script(file: &Path) -> Result<Spec, UsageErr>

pub fn parse_spec(input: &str) -> Result<Spec, UsageErr>

👎Deprecated

pub fn is_empty(&self) -> bool

Trait Implementations

impl Clone for Spec

fn clone(&self) -> Spec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Spec

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

Formats the value using the given formatter.

impl Default for Spec

fn default() -> Spec

Returns the “default value” for a type.

impl Display for Spec

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

Formats the value using the given formatter.

impl FromStr for Spec

type Err = UsageErr

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Serialize for Spec

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.