Enum ethers_solc::artifacts::ast::StructuredDocumentation

pub enum StructuredDocumentation {
    Parsed {
        text: String,
    },
    Text(String),
}

Structured documentation (NatSpec).

Variants

Parsed

Fields

text: String

The documentation is provided in the form of an AST node.

Text(String)

The documentation is provided in the form of a string literal.

Trait Implementations

impl Clone for StructuredDocumentation

fn clone(&self) -> StructuredDocumentation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StructuredDocumentation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StructuredDocumentation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for StructuredDocumentation

fn eq(&self, other: &StructuredDocumentation) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for StructuredDocumentation

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 StructuredDocumentation

impl StructuralPartialEq for StructuredDocumentation