Struct NatSpec

pub struct NatSpec {
    pub contract: String,
    pub function: Option<String>,
    pub line: String,
    pub docs: String,
}

Convenient struct to hold in-line per-test configurations

Fields

contract: String

The parent contract of the natspec

function: Option<String>

The function annotated with the natspec. None if the natspec is contract-level

line: String

The line the natspec appears, in the form row:col:length i.e. 10:21:122

docs: String

The actual natspec comment, without slashes or block punctuation

Implementations

impl NatSpec

pub fn parse(output: &ProjectCompileOutput, root: &Path) -> Vec<Self>

Factory function that extracts a vector of NatSpec instances from a solc compiler output. The root path is to express contract base dirs. That is essential to match per-test configs at runtime.

pub fn debug_context(&self) -> String

Returns a string describing the natspec context, for debugging purposes 🐞 i.e. test/Counter.t.sol:CounterTest:testFuzz_SetNumber

pub fn current_profile_configs(&self) -> impl Iterator<Item = String> + '_

Returns a list of configuration lines that match the current profile

pub fn config_lines_with_prefix<'a>( &'a self, prefix: &'a str, ) -> impl Iterator<Item = String> + 'a

Returns a list of configuration lines that match a specific string prefix

pub fn config_lines(&self) -> impl Iterator<Item = String> + '_

Returns a list of all the configuration lines available in the natspec

Trait Implementations

impl Clone for NatSpec

fn clone(&self) -> NatSpec

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NatSpec

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

Formats the value using the given formatter.

impl PartialEq for NatSpec

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

impl StructuralPartialEq for NatSpec

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 96 bytes