Type Alias ParamDocs

pub type ParamDocs = ParamDocsT<Option<(EcoString, EcoString, EcoString)>>;

Documentation about a parameter.

Aliased Type

struct ParamDocs {
    pub name: Interned<str>,
    pub docs: EcoString,
    pub cano_type: Option<(EcoString, EcoString, EcoString)>,
    pub default: Option<EcoString>,
    pub attrs: ParamAttrs,
}

Fields

name: Interned<str>

The parameter’s name.

docs: EcoString

Documentation for the parameter.

cano_type: Option<(EcoString, EcoString, EcoString)>

Inferred type of the parameter.

default: Option<EcoString>

The parameter’s default name as value.

attrs: ParamAttrs

The attribute of the parameter.

Implementations

impl ParamDocsT<Option<(EcoString, EcoString, EcoString)>>

pub fn new( param: &ParamTy, ty: Option<&Ty>, ) -> ParamDocsT<Option<(EcoString, EcoString, EcoString)>>

Trait Implementations

impl<T> Clone for ParamDocsT<T>

where T: Clone,

fn clone(&self) -> ParamDocsT<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for ParamDocsT<T>

where T: Debug,

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

Formats the value using the given formatter.

impl<T> Default for ParamDocsT<T>

where T: Default,

fn default() -> ParamDocsT<T>

Returns the “default value” for a type.

impl<'de, T> Deserialize<'de> for ParamDocsT<T>

where T: Deserialize<'de>,

fn deserialize<__D>( __deserializer: __D, ) -> Result<ParamDocsT<T>, <__D as Deserializer<'de>>::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T> Serialize for ParamDocsT<T>

where T: Serialize,

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

where __S: Serializer,

Serialize this value into the given Serde serializer.