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 validate_profiles(&self, profiles: &[Profile]) -> Result<()>

Checks if all configuration lines use a valid profile.

i.e. Given available profiles

let _profiles = vec!["ci", "default"];

A configuration like forge-config: ciii.invariant.depth = 1 would result in an error.

pub fn path(&self) -> &str

Returns the path of the contract.

pub fn location_string(&self) -> String

Returns the location of the natspec as a string.

pub fn config_values(&self) -> impl Iterator<Item = &str>

Returns a list of all the configuration values 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