Struct Param 

pub struct Param {
    pub name: &'static str,
    pub kind: Kind,
    pub required: bool,
    pub about: &'static str,
}

A typed parameter declared in a const/static command table: Param::int_in("width", 1, 16384).required().about("pixels").

Fields

name: &'static str

kind: Kind

required: bool

about: &'static str

Implementations

impl Param

pub const fn new(name: &'static str, kind: Kind) -> Self

pub const fn bool(name: &'static str) -> Self

pub const fn int(name: &'static str) -> Self

pub const fn int_in(name: &'static str, min: i64, max: i64) -> Self

pub const fn float(name: &'static str) -> Self

pub const fn float_in(name: &'static str, min: f64, max: f64) -> Self

pub const fn string(name: &'static str) -> Self

pub const fn one_of(name: &'static str, values: &'static [&'static str]) -> Self

pub const fn json(name: &'static str) -> Self

pub const fn required(self) -> Self

pub const fn about(self, about: &'static str) -> Self

pub fn to_spec(&self) -> ParamSpec

The owned, serializable form.

Trait Implementations

impl Clone for Param

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Param

impl Debug for Param

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

Formats the value using the given formatter.

impl PartialEq for Param

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Param