Struct Contract

pub struct Contract<'hir> {
    pub source: SourceId,
    pub span: Span,
    pub name: Ident,
    pub kind: ContractKind,
    pub bases: &'hir [ContractId],
    pub bases_args: &'hir [Modifier<'hir>],
    pub linearized_bases: &'hir [ContractId],
    pub linearized_bases_args: &'hir [Option<&'hir Modifier<'hir>>],
    pub ctor: Option<FunctionId>,
    pub fallback: Option<FunctionId>,
    pub receive: Option<FunctionId>,
    pub items: &'hir [ItemId],
}

A contract, interface, or library.

Fields

source: SourceId

The source this contract is defined in.

span: Span

The contract span.

name: Ident

The contract name.

kind: ContractKind

The contract kind.

bases: &'hir [ContractId]

The contract bases, as declared in the source code.

bases_args: &'hir [Modifier<'hir>]

The base arguments, as declared in the source code.

linearized_bases: &'hir [ContractId]

The linearized contract bases.

The first element is always the contract itself, followed by its bases in order of inheritance. The bases may not be present if the inheritance linearization failed. See Contract::linearization_failed.

linearized_bases_args: &'hir [Option<&'hir Modifier<'hir>>]

The constructor base arguments (if any).

The index maps to the position in linearized_bases[1..].

The reference points to either bases_args in the original contract, or modifiers in the constructor.

ctor: Option<FunctionId>

The resolved constructor function.

fallback: Option<FunctionId>

The resolved fallback function.

receive: Option<FunctionId>

The resolved receive function.

items: &'hir [ItemId]

The contract items.

Note that this only includes items defined in the contract itself, not inherited items. For getting all items, use Hir::contract_items.

Implementations

impl Contract<'_>

pub fn linearization_failed(&self) -> bool

Returns true if the inheritance linearization failed.

pub fn functions(&self) -> impl Iterator<Item = FunctionId> + Clone + use<'_>

Returns an iterator over functions declared in the contract.

Note that this does not include the constructor and fallback functions, as they are stored separately. Use Contract::all_functions to include them.

pub fn all_functions( &self, ) -> impl Iterator<Item = FunctionId> + Clone + use<'_>

Returns an iterator over all functions declared in the contract.

pub fn variables(&self) -> impl Iterator<Item = VariableId> + Clone + use<'_>

Returns an iterator over all variables declared in the contract.

pub fn can_be_deployed(&self) -> bool

Returns true if the contract can be deployed.

pub fn is_abstract(&self) -> bool

Returns true if this is an abstract contract.

pub fn description(&self) -> &'static str

Returns the description of the contract.

Trait Implementations

impl<'hir> Debug for Contract<'hir>

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

Formats the value using the given formatter.