Struct Gcx 

pub struct Gcx<'gcx>(/* private fields */);

Reference to the global context.

Implementations

impl<'gcx> Gcx<'gcx>

pub fn contract_abi<'a>(self, id: ContractId) -> Vec<AbiItem<'a>>

Returns the ABI of the given contract.

Reference: https://docs.soliditylang.org/en/develop/abi-spec.html

impl<'gcx> Gcx<'gcx>

pub fn stage(&self) -> Option<CompilerStage>

Returns the current compiler stage.

pub fn dcx(self) -> &'gcx DiagCtxt

Returns the diagnostics context.

pub fn arena(self) -> &'gcx Arena

pub fn bump(self) -> &'gcx Bump

pub fn alloc<T>(self, value: T) -> &'gcx T

pub fn mk_ty(self, kind: TyKind<'gcx>) -> Ty<'gcx>

pub fn mk_tys(self, tys: &[Ty<'gcx>]) -> &'gcx [Ty<'gcx>]

pub fn mk_ty_iter(self, tys: impl Iterator<Item = Ty<'gcx>>) -> &'gcx [Ty<'gcx>]

pub fn mk_ty_string_literal(self, s: &[u8]) -> Ty<'gcx>

pub fn mk_ty_int_literal(self, size: TypeSize) -> Ty<'gcx>

pub fn mk_ty_fn_ptr(self, ptr: TyFnPtr<'gcx>) -> Ty<'gcx>

pub fn mk_ty_fn( self, parameters: &[Ty<'gcx>], state_mutability: StateMutability, visibility: Visibility, returns: &[Ty<'gcx>], ) -> Ty<'gcx>

pub fn mk_ty_err(self, guar: ErrorGuaranteed) -> Ty<'gcx>

pub fn get_file(self, name: impl Into<FileName>) -> Option<Arc<SourceFile>>

Returns the source file with the given path, if it exists.

pub fn get_ast_source( self, name: impl Into<FileName>, ) -> Option<(SourceId, &'gcx Source<'gcx>)>

Returns the AST source at the given path, if it exists.

pub fn get_hir_source( self, name: impl Into<FileName>, ) -> Option<(SourceId, &'gcx Source<'gcx>)>

Returns the HIR source at the given path, if it exists.

pub fn item_name(self, id: impl Into<ItemId>) -> Ident

Returns the name of the given item.

Panics

Panics if the item has no name, such as unnamed function parameters.

pub fn item_canonical_name(self, id: impl Into<ItemId>) -> impl Display

Returns the canonical name of the given item.

This is the name of the item prefixed by the name of the contract it belongs to.

pub fn contract_fully_qualified_name( self, id: ContractId, ) -> impl Display + use<'gcx>

Returns the fully qualified name of the contract.

pub fn item_fields( self, id: impl Into<ItemId>, ) -> impl Iterator<Item = (Ty<'gcx>, VariableId)>

Returns an iterator over the fields of the given item.

Accepts structs, functions, errors, and events.

pub fn item_parameters(self, id: impl Into<ItemId>) -> &'gcx [VariableId]

Returns the parameter variable declarations of the given function-like item.

Also accepts structs.

Panics

Panics if the item is not a function-like item or a struct.

pub fn item_parameters_opt( self, id: impl Into<ItemId>, ) -> Option<&'gcx [VariableId]>

Returns the parameter variable declarations of the given function-like item.

Also accepts structs.

pub fn item_parameter_types(self, id: impl Into<ItemId>) -> &'gcx [Ty<'gcx>]

Returns the return variable declarations of the given function-like item.

Panics

Panics if the item is not a function-like item.

pub fn item_parameter_types_opt( self, id: impl Into<ItemId>, ) -> Option<&'gcx [Ty<'gcx>]>

Returns the return variable declarations of the given function-like item.

Panics

Panics if the item is not a function-like item.

pub fn item_name_opt(self, id: impl Into<ItemId>) -> Option<Ident>

Returns the name of the given item.

pub fn item_span(self, id: impl Into<ItemId>) -> Span

Returns the span of the given item.

pub fn function_selector(self, id: impl Into<ItemId>) -> FixedBytes<4>

Returns the 4-byte selector of the given item. Only accepts functions and errors.

Panics

Panics if the item is not a function or error.

pub fn event_selector(self, id: EventId) -> FixedBytes<32>

Returns the 32-byte selector of the given event.

pub fn type_of_hir_ty(self, ty: &Type<'_>) -> Ty<'gcx>

Computes the Ty of the given hir::Type. Not cached.

pub fn type_of_res(self, res: Res) -> Ty<'gcx>

Returns the type of the given hir::Res.

impl<'gcx> Gcx<'gcx>

pub fn interface_id(self, id: ContractId) -> FixedBytes<4>

Returns the ERC-165 interface ID of the given contract.

This is the XOR of the selectors of all function selectors in the interface.

The solc implementation excludes inheritance: https://github.com/argotorg/solidity/blob/ad2644c52b3afbe80801322c5fe44edb59383500/libsolidity/ast/AST.cpp#L310-L316

See ERC-165 for more details.

pub fn interface_functions(self, id: ContractId) -> InterfaceFunctions<'gcx>

Returns all the exported functions of the given contract.

The contract doesn’t have to be an interface.

pub fn item_signature(self, id: ItemId) -> &'gcx str

Returns the ABI signature of the given item. Only accepts functions, errors, and events.

pub fn type_of_item(self, id: ItemId) -> Ty<'gcx>

Returns the type of the given item.

pub fn struct_field_types(self, id: StructId) -> &'gcx [Ty<'gcx>]

Returns the types of the fields of the given struct.

pub fn struct_recursiveness(self, id: StructId) -> Recursiveness

Returns the recursiveness of the given struct.

pub fn members_of(self, ty: Ty<'gcx>) -> &'gcx [Member<'gcx>]

Returns the members of the given type.

Trait Implementations

impl<'gcx> Clone for Gcx<'gcx>

fn clone(&self) -> Gcx<'gcx>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'gcx> Debug for Gcx<'gcx>

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

Formats the value using the given formatter.

impl<'gcx> Deref for Gcx<'gcx>

type Target = &'gcx GlobalCtxt<'gcx>

The resulting type after dereferencing.

fn deref(&self) -> &<Gcx<'gcx> as Deref>::Target

Dereferences the value.

impl<'gcx> Copy for Gcx<'gcx>