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 strPlaceholder string in the @param roxygen tag, e.g.
".__MX_MATCH_ARG_PARAM_DOC_match_arg_set_mode_mode__".
several_ok: booltrue for several_ok params (emits “One or more of …”);
false for plain match_arg (emits “One of …”).
suffix: &'static strText 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() -> StringFunction that returns the choices as a comma-separated quoted string,
e.g. "\"Fast\", \"Safe\", \"Debug\"".
Trait Implementations§
impl Sync for MatchArgParamDocEntry
Auto Trait Implementations§
impl Forget for MatchArgParamDocEntry
impl Freeze for MatchArgParamDocEntry
impl RefUnwindSafe for MatchArgParamDocEntry
impl Send for MatchArgParamDocEntry
impl Unpin for MatchArgParamDocEntry
impl UnsafeUnpin for MatchArgParamDocEntry
impl UnwindSafe for MatchArgParamDocEntry
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> SizeHint for Twhere
T: ?Sized,
impl<T> SizeHint for Twhere
T: ?Sized,
Source§default fn lower_bound(&self) -> usize
default fn lower_bound(&self) -> usize
core_io_internals)[u8; 12] could return any value between 0 and
12 inclusively as a correct implementation. Read moreSource§impl<T> SizedTypeProperties for T
impl<T> SizedTypeProperties for T
Source§#[doc(hidden)]const SIZE: usize
#[doc(hidden)]const SIZE: usize
sized_type_properties)Source§#[doc(hidden)]const ALIGN: usize
#[doc(hidden)]const ALIGN: usize
sized_type_properties)Source§#[doc(hidden)]const ALIGNMENT: Alignment
#[doc(hidden)]const ALIGNMENT: Alignment
ptr_alignment_type)Source§#[doc(hidden)]const IS_ZST: bool
#[doc(hidden)]const IS_ZST: bool
sized_type_properties)Source§#[doc(hidden)]const LAYOUT: Layout
#[doc(hidden)]const LAYOUT: Layout
sized_type_properties)Source§#[doc(hidden)]const MAX_SLICE_LEN: usize
#[doc(hidden)]const MAX_SLICE_LEN: usize
sized_type_properties)[Self]. Read moreLayout§
Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.
Size: 48 bytes