Skip to main content

ParamInfo

Struct ParamInfo 

Source
pub struct ParamInfo {
Show 13 fields pub name: Ident, pub ty: Type, pub is_optional: bool, pub is_bool: bool, pub is_vec: bool, pub vec_inner: Option<Type>, pub is_id: bool, pub wire_name: Option<String>, pub location: Option<ParamLocation>, pub default_value: Option<String>, pub short_flag: Option<char>, pub help_text: Option<String>, pub is_positional: bool,
}
Expand description

Parsed parameter information

Fields§

§name: Ident

Parameter name

§ty: Type

Parameter type

§is_optional: bool

Whether this is Option<T>

§is_bool: bool

Whether this is bool

§is_vec: bool

Whether this is Vec<T>

§vec_inner: Option<Type>

Inner type if Vec<T>

§is_id: bool

Whether this looks like an ID (ends with _id or is named id)

§wire_name: Option<String>

Custom wire name (from #[param(name = “…”)])

§location: Option<ParamLocation>

Parameter location override (from #[param(query/path/body/header)])

§default_value: Option<String>

Default value as a string (from #[param(default = …)])

§short_flag: Option<char>

Short flag character (from #[param(short = ‘x’)])

§help_text: Option<String>

Custom help text (from #[param(help = “…”)])

§is_positional: bool

Whether this is a positional argument (from #[param(positional)] or is_id heuristic)

Implementations§

Source§

impl ParamInfo

Source

pub fn name_str(&self) -> String

Parameter name as a protocol string, stripping the r# prefix from raw identifiers.

Use this instead of .name.to_string() whenever generating protocol-level names (CLI flags, HTTP query params, JSON schema properties, etc.).

Trait Implementations§

Source§

impl Clone for ParamInfo

Source§

fn clone(&self) -> ParamInfo

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
Source§

impl Debug for ParamInfo

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

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
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

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

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

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

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.