Struct SpecGroup 

#[non_exhaustive]
pub struct SpecGroup {
    pub name: String,
    pub members: Vec<String>,
    pub required: bool,
    pub multiple: bool,
}

A set of flags that relate to one another as a set.

Everything here could be written as pairwise conflicts — for three members, three declarations, and for six, fifteen — except for the part that cannot: “one of these is required” is a statement about the set, and no rule written on an individual flag says it.

The two properties are clap’s, and are read the same way:

• multiple (default false) — whether more than one member may be given. The default is what makes a bare group mutual exclusion.
• required (default false) — whether at least one member must be given.

So the default group is “at most one of these”, required alone is “exactly one of these”, and multiple with required is “at least one of these”.

Members use the same selectors as other relationships: --long or -s for a flag, and the bare argument name for a positional.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

What this group is called. Used in messages, and it is how a reader tells two groups apart when a command has several.

members: Vec<String>

The arguments in the group, as selectors. Flags use dashed spellings; positionals use their bare names.

required: bool

Whether at least one member has to be given.

multiple: bool

Whether more than one member may be given.

Implementations

impl SpecGroup

pub fn new( name: impl Into<String>, members: impl IntoIterator<Item = impl Into<String>>, ) -> Self

A group named name holding members, exclusive and not required — the defaults clap uses.

pub fn required(self) -> Self

The same, but at least one member must be given.

pub fn multiple(self) -> Self

The same, but more than one member may be given.

pub fn usage(&self) -> String

Trait Implementations

impl Clone for SpecGroup

fn clone(&self) -> SpecGroup

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SpecGroup

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

Formats the value using the given formatter.

impl Default for SpecGroup

fn default() -> SpecGroup

Returns the “default value” for a type.

impl Display for SpecGroup

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

Formats the value using the given formatter.

impl From<&SpecGroup> for KdlNode

fn from(group: &SpecGroup) -> KdlNode

Converts to this type from the input type.

impl Serialize for SpecGroup

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

where __S: Serializer,

Serialize this value into the given Serde serializer.