Struct MatchArgParamDocEntry

Source

pub struct MatchArgParamDocEntry {
    pub placeholder: &'static str,
    pub several_ok: bool,
    pub suffix: &'static str,
    pub choices_str: fn() -> String,
}

Expand description

Entry for replacing match_arg @param doc placeholders with human-readable choice descriptions.

Fields§

§placeholder: &'static str

Placeholder string in the @param roxygen tag, e.g. ".__MX_MATCH_ARG_PARAM_DOC_match_arg_set_mode_mode__".

§several_ok: bool

true for several_ok params (emits “One or more of …”); false for plain match_arg (emits “One of …”).

§suffix: &'static str

Text after the rendered choice list, before the closing period: "" for a plain param, ", or NULL for no choice" for an Option<T> one (#1473), an omission note for Missing<T> (#1551). Composed by the macro from the parameter type.

§choices_str: fn() -> String

Function that returns the choices as a comma-separated quoted string, e.g. "\"Fast\", \"Safe\", \"Debug\"".

Trait Implementations§

Source §

impl Sync for MatchArgParamDocEntry

Auto Trait Implementations§

§

impl UnwindSafe for MatchArgParamDocEntry

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 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> SizeHint for T
where T: ?Sized,

Source §

default fn lower_bound(&self) -> usize

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

Returns a lower bound on the number of elements this container-like item contains. For example, an array [u8; 12] could return any value between 0 and 12 inclusively as a correct implementation. Read more

Source §

default fn upper_bound(&self) -> Option<usize>

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

Returns an upper bound on the number of elements this container-like item contains if it can be determined, otherwise None. Read more

Source §

final fn size_hint(&self) -> (usize, Option<usize>)

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

Returns an estimate for the number of elements this container like type contains. Read more

Source §