Struct evmil::bytecode::Assembly

pub struct Assembly { /* private fields */ }

A structured representation of an EVM bytecode contract which is either a legacy contract, or an EVM Object Format (EOF) compatiable contract. Regardless of whether it is legacy or not, a contract is divided into one or more sections. A section is either a code section or a data section. For EOF contracts, the data section should also come last. However, for legacy contracts, they can be interleaved.

Implementations

impl Assembly

pub fn from_legacy_bytes(bytes: &[u8]) -> Assembly

pub fn from_eof_bytes(bytes: &[u8]) -> Result<Assembly, DecodingError>

A decoded EOF byte sequence (see EIP3540). This provides a gateway for disassembling EOF contracts into assembly language and back again.

Examples

use evmil::bytecode::Assembly;
use evmil::util::FromHexString;

// EOF bytecode contract
let hex = "0xef00010100040200010001030000000000000000";
// Conversion into bytes
let bytes = hex.from_hex_string().unwrap();
// Decode EOF bytecode (assuming no errors)
let eof = Assembly::from_eof_bytes(&bytes).unwrap();
// Check that section contains one instruction
// assert_eq!(eof.sections.len(),1);

pub fn empty() -> Self

pub fn new(sections: Vec<StructuredSection>) -> Self

pub fn len(&self) -> usize

Return the number of sections in the code.

pub fn is_empty(&self) -> bool

Return true if the are no sections in this assembly.

pub fn iter(&self) -> Iter<'_, StructuredSection>

pub fn iter_mut(&mut self) -> IterMut<'_, StructuredSection>

pub fn add(&mut self, section: StructuredSection)

Add a new section to this bytecode container

pub fn from_str(input: &str) -> Result<Assembly, ParseError>

Parse some assembly language into an Assembly. This can fail for a variety of reasons, such as an unknown instruction is used or there is some unexpected junk in the file.

impl Assembly

pub fn to_legacy_bytes(&self) -> Vec<u8>

pub fn to_eof_bytes(&self) -> Vec<u8>

Trait Implementations

impl Clone for Assembly

fn clone(&self) -> Assembly

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Assembly

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

Formats the value using the given formatter.

impl<'a> IntoIterator for &'a Assembly

type Item = &'a StructuredSection

The type of the elements being iterated over.

type IntoIter = Iter<'a, StructuredSection>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut Assembly

type Item = &'a mut StructuredSection

The type of the elements being iterated over.

type IntoIter = IterMut<'a, StructuredSection>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl PartialEq for Assembly

fn eq(&self, other: &Assembly) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl TryFrom<&[Term]> for Assembly

Translate a sequence of IL statements into EVM bytecode, or fail with an error.

type Error = CompilerError

The type returned in the event of a conversion error.

fn try_from(terms: &[Term]) -> Result<Self, Self::Error>

Performs the conversion.

impl<const N: usize> TryFrom<&[Term; N]> for Assembly

Translate a sequence of IL statements into EVM bytecode, or fail with an error.

type Error = CompilerError

The type returned in the event of a conversion error.

fn try_from(terms: &[Term; N]) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Assembly