Struct Param

pub struct Param {
    pub doc: Option<Cow<'static, str>>,
    pub name: Option<Cow<'static, str>>,
    /* private fields */
}

A function parameter type representation

Fields

doc: Option<Cow<'static, str>>

name: Option<Cow<'static, str>>

If the parameter has a name (will default to Param{number} if None)

Implementations

impl Param

pub fn set_name(&mut self, name: impl Into<Cow<'static, str>>) -> &mut Self

Set the parameters name

pub fn set_doc(&mut self, doc: impl Into<Cow<'static, str>>) -> &mut Self

Set the parameters doc comment

Trait Implementations

impl Clone for Param

fn clone(&self) -> Param

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Param

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

Formats the value using the given formatter.

impl<I: Into<Cow<'static, str>>> From<(I, Type)> for Param

fn from((name, ty): (I, Type)) -> Self

Converts to this type from the input type.

impl From<Type> for Param

fn from(value: Type) -> Self

Converts to this type from the input type.

impl Ord for Param

fn cmp(&self, other: &Param) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Param

fn eq(&self, other: &Param) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Param

fn partial_cmp(&self, other: &Param) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Param

impl StructuralPartialEq for Param