Struct DocCommentSig 

pub struct DocCommentSig {
    pub label: bool,
    pub args: Option<Vec<DocCommentArg>>,
    pub outputs: Option<Vec<DocCommentArg>>,
}

A signature in a doc comment

Fields

label: bool

Whether this is a labelling signature

args: Option<Vec<DocCommentArg>>

The arguments of the signature

outputs: Option<Vec<DocCommentArg>>

The outputs of the signature

Implementations

impl DocCommentSig

pub fn matches_sig(&self, sig: Signature) -> bool

Whether the doc comment signature matches a given function signature

Trait Implementations

impl Clone for DocCommentSig

fn clone(&self) -> DocCommentSig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocCommentSig

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

Formats the value using the given formatter.

impl Default for DocCommentSig

fn default() -> DocCommentSig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocCommentSig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for DocCommentSig

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

Formats the value using the given formatter.

impl FromStr for DocCommentSig

type Err = ()

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for DocCommentSig

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

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 DocCommentSig

impl StructuralPartialEq for DocCommentSig