HelpItem

bpaf::meta_help

Enum HelpItem

pub(crate) enum HelpItem<'a> {
    DecorSuffix {
        help: &'a Doc,
        ty: HiTy,
    },
    GroupStart {
        help: &'a Doc,
        ty: HiTy,
    },
    GroupEnd {
        ty: HiTy,
    },
    Any {
        metavar: &'a Doc,
        anywhere: bool,
        help: Option<&'a Doc>,
    },
    Positional {
        metavar: Metavar,
        help: Option<&'a Doc>,
    },
    Command {
        name: &'static str,
        short: Option<char>,
        help: Option<&'a Doc>,
        meta: &'a Meta,
    },
    Flag {
        name: ShortLong,
        env: Option<&'static str>,
        help: Option<&'a Doc>,
    },
    Argument {
        name: ShortLong,
        metavar: Metavar,
        env: Option<&'static str>,
        help: Option<&'a Doc>,
    },
    AnywhereStart {
        inner: &'a Meta,
        ty: HiTy,
    },
    AnywhereStop {
        ty: HiTy,
    },
}

Variants§

DecorSuffix

Fields

§help: &'a Doc

§ty: HiTy

GroupStart

Fields

§help: &'a Doc

§ty: HiTy

GroupEnd

Fields

§ty: HiTy

Any

Fields

§metavar: &'a Doc

§anywhere: bool

§help: Option<&'a Doc>

Positional

Fields

§metavar: Metavar

§help: Option<&'a Doc>

Command

Fields

§name: &'static str

§short: Option<char>

§help: Option<&'a Doc>

§meta: &'a Meta

Flag

Fields

§name: ShortLong

§env: Option<&'static str>

§help: Option<&'a Doc>

Argument

Fields

§name: ShortLong

§metavar: Metavar

§env: Option<&'static str>

§help: Option<&'a Doc>

AnywhereStart

Fields

§inner: &'a Meta

§ty: HiTy

AnywhereStop

Fields

§ty: HiTy

Implementations§

impl HelpItem<'_>

fn has_help(&self) -> bool

fn ty(&self) -> HiTy

Trait Implementations§

impl<'a> Clone for HelpItem<'a>

fn clone(&self) -> HelpItem<'a>

Returns a duplicate of the value. Read more

1.0.0 · Source§

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

Performs copy-assignment from source. Read more

impl<'a> Debug for HelpItem<'a>

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

Formats the value using the given formatter. Read more

impl<'a> Copy for HelpItem<'a>

Auto Trait Implementations§

impl<'a> Freeze for HelpItem<'a>

impl<'a> RefUnwindSafe for HelpItem<'a>

impl<'a> Send for HelpItem<'a>

impl<'a> Sync for HelpItem<'a>

impl<'a> Unpin for HelpItem<'a>

impl<'a> UnwindSafe for HelpItem<'a>

Blanket Implementations§

impl<T> Any for T
where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T
where T: ?Sized,

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T
where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> CloneToUninit for T
where T: Clone,

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

impl<T> From<T> for T

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into<U> for T
where U: From<T>,

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> ToOwned for T
where T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom<U> for T
where U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.