pub struct Gcx<'gcx>(/* private fields */);Expand description
Reference to the global context.
Implementations§
Source§impl<'gcx> Gcx<'gcx>
impl<'gcx> Gcx<'gcx>
Sourcepub fn contract_abi<'a>(self, id: ContractId) -> Vec<AbiItem<'a>>
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
Source§impl<'gcx> Gcx<'gcx>
impl<'gcx> Gcx<'gcx>
Sourcepub fn stage(&self) -> Option<CompilerStage>
pub fn stage(&self) -> Option<CompilerStage>
Returns the current compiler stage.
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>
Sourcepub fn get_file(self, name: impl Into<FileName>) -> Option<Arc<SourceFile>>
pub fn get_file(self, name: impl Into<FileName>) -> Option<Arc<SourceFile>>
Returns the source file with the given path, if it exists.
Sourcepub fn get_ast_source(
self,
name: impl Into<FileName>,
) -> Option<(SourceId, &'gcx Source<'gcx>)>
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.
Sourcepub fn get_hir_source(
self,
name: impl Into<FileName>,
) -> Option<(SourceId, &'gcx Source<'gcx>)>
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.
Sourcepub fn item_name(self, id: impl Into<ItemId>) -> Ident
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.
Sourcepub fn item_canonical_name(self, id: impl Into<ItemId>) -> impl Display
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.
Sourcepub fn contract_fully_qualified_name(
self,
id: ContractId,
) -> impl Display + use<'gcx>
pub fn contract_fully_qualified_name( self, id: ContractId, ) -> impl Display + use<'gcx>
Returns the fully qualified name of the contract.
Sourcepub fn item_fields(
self,
id: impl Into<ItemId>,
) -> impl Iterator<Item = (Ty<'gcx>, VariableId)>
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.
Sourcepub fn item_parameters(self, id: impl Into<ItemId>) -> &'gcx [VariableId]
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.
Sourcepub fn item_parameters_opt(
self,
id: impl Into<ItemId>,
) -> Option<&'gcx [VariableId]>
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.
Sourcepub fn item_parameter_types(self, id: impl Into<ItemId>) -> &'gcx [Ty<'gcx>]
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.
Sourcepub fn item_parameter_types_opt(
self,
id: impl Into<ItemId>,
) -> Option<&'gcx [Ty<'gcx>]>
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.
Sourcepub fn item_name_opt(self, id: impl Into<ItemId>) -> Option<Ident>
pub fn item_name_opt(self, id: impl Into<ItemId>) -> Option<Ident>
Returns the name of the given item.
Sourcepub fn function_selector(self, id: impl Into<ItemId>) -> Selector
pub fn function_selector(self, id: impl Into<ItemId>) -> Selector
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.
Sourcepub fn event_selector(self, id: EventId) -> B256
pub fn event_selector(self, id: EventId) -> B256
Returns the 32-byte selector of the given event.
Sourcepub fn type_of_hir_ty(self, ty: &Type<'_>) -> Ty<'gcx>
pub fn type_of_hir_ty(self, ty: &Type<'_>) -> Ty<'gcx>
Sourcepub fn type_of_res(self, res: Res) -> Ty<'gcx>
pub fn type_of_res(self, res: Res) -> Ty<'gcx>
Returns the type of the given hir::Res.
Source§impl<'gcx> Gcx<'gcx>
impl<'gcx> Gcx<'gcx>
Sourcepub fn interface_id(self, id: ContractId) -> Selector
pub fn interface_id(self, id: ContractId) -> Selector
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.
Sourcepub fn interface_functions(self, id: ContractId) -> InterfaceFunctions<'gcx>
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.
Sourcepub fn item_signature(self, id: ItemId) -> &'gcx str
pub fn item_signature(self, id: ItemId) -> &'gcx str
Returns the ABI signature of the given item. Only accepts functions, errors, and events.
Sourcepub fn type_of_item(self, id: ItemId) -> Ty<'gcx>
pub fn type_of_item(self, id: ItemId) -> Ty<'gcx>
Returns the type of the given item.
Sourcepub fn struct_field_types(self, id: StructId) -> &'gcx [Ty<'gcx>]
pub fn struct_field_types(self, id: StructId) -> &'gcx [Ty<'gcx>]
Returns the types of the fields of the given struct.
Sourcepub fn struct_recursiveness(self, id: StructId) -> Recursiveness
pub fn struct_recursiveness(self, id: StructId) -> Recursiveness
Returns the recursiveness of the given struct.
Sourcepub fn members_of(self, ty: Ty<'gcx>) -> MemberList<'gcx>
pub fn members_of(self, ty: Ty<'gcx>) -> MemberList<'gcx>
Returns the members of the given type.
Trait Implementations§
impl<'gcx> Copy for Gcx<'gcx>
Auto Trait Implementations§
impl<'gcx> Freeze for Gcx<'gcx>
impl<'gcx> !RefUnwindSafe for Gcx<'gcx>
impl<'gcx> Send for Gcx<'gcx>
impl<'gcx> Sync for Gcx<'gcx>
impl<'gcx> Unpin for Gcx<'gcx>
impl<'gcx> !UnwindSafe for Gcx<'gcx>
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T, R> CollectAndApply<T, R> for T
impl<T, R> CollectAndApply<T, R> for T
Source§impl<T> FmtForward for T
impl<T> FmtForward for T
Source§fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
fn fmt_binary(self) -> FmtBinary<Self>where
Self: Binary,
self to use its Binary implementation when Debug-formatted.Source§fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
fn fmt_display(self) -> FmtDisplay<Self>where
Self: Display,
self to use its Display implementation when
Debug-formatted.Source§fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
fn fmt_lower_exp(self) -> FmtLowerExp<Self>where
Self: LowerExp,
self to use its LowerExp implementation when
Debug-formatted.Source§fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
fn fmt_lower_hex(self) -> FmtLowerHex<Self>where
Self: LowerHex,
self to use its LowerHex implementation when
Debug-formatted.Source§fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
fn fmt_octal(self) -> FmtOctal<Self>where
Self: Octal,
self to use its Octal implementation when Debug-formatted.Source§fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
fn fmt_pointer(self) -> FmtPointer<Self>where
Self: Pointer,
self to use its Pointer implementation when
Debug-formatted.Source§fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
fn fmt_upper_exp(self) -> FmtUpperExp<Self>where
Self: UpperExp,
self to use its UpperExp implementation when
Debug-formatted.Source§fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
fn fmt_upper_hex(self) -> FmtUpperHex<Self>where
Self: UpperHex,
self to use its UpperHex implementation when
Debug-formatted.Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Pipe for Twhere
T: ?Sized,
impl<T> Pipe for Twhere
T: ?Sized,
Source§fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
fn pipe<R>(self, func: impl FnOnce(Self) -> R) -> Rwhere
Self: Sized,
Source§fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref<'a, R>(&'a self, func: impl FnOnce(&'a Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
fn pipe_ref_mut<'a, R>(&'a mut self, func: impl FnOnce(&'a mut Self) -> R) -> Rwhere
R: 'a,
self and passes that borrow into the pipe function. Read moreSource§fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
fn pipe_borrow<'a, B, R>(&'a self, func: impl FnOnce(&'a B) -> R) -> R
Source§fn pipe_borrow_mut<'a, B, R>(
&'a mut self,
func: impl FnOnce(&'a mut B) -> R,
) -> R
fn pipe_borrow_mut<'a, B, R>( &'a mut self, func: impl FnOnce(&'a mut B) -> R, ) -> R
Source§fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
fn pipe_as_ref<'a, U, R>(&'a self, func: impl FnOnce(&'a U) -> R) -> R
self, then passes self.as_ref() into the pipe function.Source§fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
fn pipe_as_mut<'a, U, R>(&'a mut self, func: impl FnOnce(&'a mut U) -> R) -> R
self, then passes self.as_mut() into the pipe
function.Source§fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
fn pipe_deref<'a, T, R>(&'a self, func: impl FnOnce(&'a T) -> R) -> R
self, then passes self.deref() into the pipe function.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> Tap for T
impl<T> Tap for T
Source§fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow<B>(self, func: impl FnOnce(&B)) -> Self
Borrow<B> of a value. Read moreSource§fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut<B>(self, func: impl FnOnce(&mut B)) -> Self
BorrowMut<B> of a value. Read moreSource§fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref<R>(self, func: impl FnOnce(&R)) -> Self
AsRef<R> view of a value. Read moreSource§fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut<R>(self, func: impl FnOnce(&mut R)) -> Self
AsMut<R> view of a value. Read moreSource§fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref<T>(self, func: impl FnOnce(&T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
fn tap_deref_mut<T>(self, func: impl FnOnce(&mut T)) -> Self
Deref::Target of a value. Read moreSource§fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
fn tap_dbg(self, func: impl FnOnce(&Self)) -> Self
.tap() only in debug builds, and is erased in release builds.Source§fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
fn tap_mut_dbg(self, func: impl FnOnce(&mut Self)) -> Self
.tap_mut() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
fn tap_borrow_dbg<B>(self, func: impl FnOnce(&B)) -> Self
.tap_borrow() only in debug builds, and is erased in release
builds.Source§fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
fn tap_borrow_mut_dbg<B>(self, func: impl FnOnce(&mut B)) -> Self
.tap_borrow_mut() only in debug builds, and is erased in release
builds.Source§fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
fn tap_ref_dbg<R>(self, func: impl FnOnce(&R)) -> Self
.tap_ref() only in debug builds, and is erased in release
builds.Source§fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
fn tap_ref_mut_dbg<R>(self, func: impl FnOnce(&mut R)) -> Self
.tap_ref_mut() only in debug builds, and is erased in release
builds.Source§fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
fn tap_deref_dbg<T>(self, func: impl FnOnce(&T)) -> Self
.tap_deref() only in debug builds, and is erased in release
builds.