Struct Contract 

pub struct Contract {
    pub macros: Vec<MacroDefinition>,
    pub invocations: Vec<MacroInvocation>,
    pub imports: Vec<FilePath>,
    pub constants: Vec<ConstantDefinition>,
    pub functions: Vec<Function>,
    pub events: Vec<Event>,
    pub tables: Vec<Table>,
}

A Huff Contract Representation

This is the representation of a contract as it is parsed from huff source code. Thus, it is also the root of the AST.

For examples of Huff contracts, see the huff-examples repository.

Fields

macros: Vec<MacroDefinition>

Macro definitions

invocations: Vec<MacroInvocation>

Invocations of macros

imports: Vec<FilePath>

File Imports

constants: Vec<ConstantDefinition>

Constants

functions: Vec<Function>

Functions

events: Vec<Event>

Events

tables: Vec<Table>

Tables

Implementations

impl Contract

pub fn find_macro_by_name(&self, name: &str) -> Option<MacroDefinition>

Returns the first macro that matches the provided name

pub fn derive_storage_pointers(&mut self)

Derives the FreeStoragePointers into their bytes32 representation

Trait Implementations

impl Clone for Contract

fn clone(&self) -> Contract

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Contract

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

Formats the value using the given formatter.

impl Default for Contract

fn default() -> Contract

Returns the “default value” for a type.

impl From<Contract> for Abi

fn from(contract: Contract) -> Self

Converts to this type from the input type.

impl Ord for Contract

fn cmp(&self, other: &Contract) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Contract

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

fn partial_cmp(&self, other: &Contract) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Contract

impl StructuralPartialEq for Contract