Struct seahorse::Flag

pub struct Flag {
    pub name: String,
    pub description: Option<String>,
    pub flag_type: FlagType,
    pub alias: Option<Vec<String>>,
}

Flag type.

Option flag struct

Fields

name: String

Flag name

description: Option<String>

Flag description

flag_type: FlagType

Flag type

alias: Option<Vec<String>>

Flag alias

Implementations

impl Flag

pub fn new<T: Into<String>>(name: T, flag_type: FlagType) -> Self

Create new instance of Flag

Example

use seahorse::{Flag, FlagType};

let bool_flag = Flag::new("bool", FlagType::Bool);
let float_flag = Flag::new("float", FlagType::Float);

pub fn description<T: Into<String>>(self, description: T) -> Self

Set description of the flag

Example

use seahorse::{Flag, FlagType};

let bool_flag = Flag::new("bool", FlagType::Bool)
    .description("cli cmd Hello --bool");

pub fn alias<T: Into<String>>(self, name: T) -> Self

Set alias of the flag

Example

use seahorse::{Flag, FlagType};

let bool_flag = Flag::new("bool", FlagType::Bool)
    .alias("b");

let string_flag = Flag::new("string", FlagType::String)
    .alias("s")
    .alias("str");

pub fn option_index(&self, v: &[String]) -> Option<usize>

Get flag position from command line argument

pub fn value(&self, v: Option<String>) -> Result<FlagValue, FlagError>

Get flag value

Trait Implementations

impl Clone for Flag

fn clone(&self) -> Flag

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Flag

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

Formats the value using the given formatter.