Struct DocComment 

pub struct DocComment {
    pub text: EcoString,
    pub sig: Option<DocCommentSig>,
}

A comment that documents a binding

Fields

text: EcoString

The comment text

sig: Option<DocCommentSig>

The signature of the binding

Trait Implementations

impl Clone for DocComment

fn clone(&self) -> DocComment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocComment

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

Formats the value using the given formatter.

impl Default for DocComment

fn default() -> DocComment

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for DocComment

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&str> for DocComment

fn from(text: &str) -> Self

Converts to this type from the input type.

impl From<String> for DocComment

fn from(text: String) -> Self

Converts to this type from the input type.

impl PartialEq for DocComment

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

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 DocComment

impl StructuralPartialEq for DocComment