Struct OptionGroup 

pub struct OptionGroup { /* private fields */ }

The OptionGroup is used to specify mutually exclusive options.

Example

Create option group [-optA | -optB]

use anpcli::{AnpOption, OptionGroup, Options};
let group = OptionGroup::new()
    .add_option(AnpOption::builder().option("optA").build().unwrap())
    .add_option(AnpOption::builder().option("optB").build().unwrap());

let mut options = Options::new();
options.add_option_group(group);

Implementations

impl OptionGroup

pub fn new() -> OptionGroup

Create a new OptionGroup.

pub fn add_option(self, option: AnpOption) -> Self

Add an option to the group. If the same option key already exists, it’s a replacement operation.

pub fn get_names(&self) -> Vec<&str>

Get the keys of all options in the group. The key is short option name if exists, otherwise long option name.

pub fn get_options(&self) -> Vec<Rc<RefCell<AnpOption>>>

Get the owned reference of the options in the group.

pub fn get_selected(&self) -> Option<&String>

Get selected option key in the group.

pub fn is_required(&self) -> bool

Check whether the group is required.

pub fn set_required(&mut self, required: bool)

Set whether the group is required.

pub fn set_selected( &mut self, option: Option<&AnpOption>, ) -> Result<(), OptionErr>

Set the selected key in the group. This is for internal usage.

Trait Implementations

impl Debug for OptionGroup

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

Formats the value using the given formatter.

impl Display for OptionGroup

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

Formats the value using the given formatter.

impl Hash for OptionGroup

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for OptionGroup

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for OptionGroup