Struct ContractDoc

pub struct ContractDoc {
    pub details: Option<String>,
    pub events: Option<String>,
    pub kind: String,
    pub methods: HashMap<String, FunctionDoc>,
    pub version: String,
}

Fields

details: Option<String>

A description of the contract

events: Option<String>

A description of the contract`s events

kind: String

Is it devdoc or userdoc

methods: HashMap<String, FunctionDoc>

The description of the contract functions

version: String

The version of the contract

Implementations

impl ContractDoc

pub fn new( kind: String, methods: HashMap<String, FunctionDoc>, version: String, ) -> ContractDoc

Trait Implementations

impl Clone for ContractDoc

fn clone(&self) -> ContractDoc

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ContractDoc

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

Formats the value using the given formatter.

impl Default for ContractDoc

fn default() -> ContractDoc

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ContractDoc

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ContractDoc

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ContractDoc