Enum NatSpecKind 

pub enum NatSpecKind {
    Title,
    Author,
    Notice,
    Dev,
    Param {
        name: String,
    },
    Return {
        name: Option<String>,
    },
    Inheritdoc {
        parent: String,
    },
    Custom {
        tag: String,
    },
}

Variants

Title

Author

Notice

Dev

Param

Fields

name: String

Return

Fields

name: Option<String>

Inheritdoc

Fields

parent: String

Custom

Fields

tag: String

Implementations

impl NatSpecKind

pub fn is_param(&self) -> bool

pub fn is_return(&self) -> bool

pub fn is_notice(&self) -> bool

pub fn is_dev(&self) -> bool

Trait Implementations

impl Clone for NatSpecKind

fn clone(&self) -> NatSpecKind

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NatSpecKind

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

Formats the value using the given formatter.

impl PartialEq for NatSpecKind

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

impl StructuralPartialEq for NatSpecKind