Skip to main content

CliOptionParser

Struct CliOptionParser 

Source
pub struct CliOptionParser { /* private fields */ }
Expand description

A parser for CLI options and arguments.

This struct allows registering options with short and long forms, parsing command-line arguments, and retrieving the values of options or normal arguments.

Implementations§

Source§

impl CliOptionParser

Source

pub fn new(header: String, footer: String) -> CliOptionParser

Creates a new CliOptionParser instance with the given header and footer text.

Source

pub fn parse(&mut self) -> Vec<String>

Parses the command-line arguments and returns the list of normal arguments.

Source

pub fn is_enabled(&self, name: &str) -> bool

Checks if the option with the given name is enabled.

Source

pub fn get_option_values(&self, name: &str) -> &Vec<String>

Returns the values associated with the option name, or an empty list if not enabled.

Source

pub fn register_option( &mut self, short_form: Option<String>, long_form: Option<String>, help_text: &str, name: &str, )

Registers a new CLI option with the given short form, long form, help text, and name.

Source

pub fn help_text(&self) -> String

Generates and returns the help text for the CLI options.

Trait Implementations§

Source§

impl Index<&str> for CliOptionParser

Source§

fn index(&self, index: &str) -> &Self::Output

Allows indexing the parser with an option name to retrieve its values.

Source§

type Output = Vec<String>

The returned type after indexing.

Auto Trait Implementations§

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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.