Struct ParamDoc 

pub struct ParamDoc {
    pub name: String,
    pub ty: String,
    pub required: bool,
    pub description: String,
    pub max_len: Option<usize>,
    pub enum_values: Vec<String>,
}

Serializable documentation for a single action parameter.

Fields

name: String

Parameter name.

ty: String

JSON type of the parameter.

required: bool

Whether the parameter is required.

description: String

Human-readable description of the parameter.

max_len: Option<usize>

Maximum allowed length, when length-bounded.

enum_values: Vec<String>

Permitted values when the parameter is an enum.

Trait Implementations

impl Clone for ParamDoc

fn clone(&self) -> ParamDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ParamDoc

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

Formats the value using the given formatter.

impl PartialEq for ParamDoc

fn eq(&self, other: &ParamDoc) -> 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 Serialize for ParamDoc

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for ParamDoc

impl StructuralPartialEq for ParamDoc