Enum ContractFileParseError 

pub enum ContractFileParseError {
    FileTooLarge {
        file_size: usize,
    },
    NoHeader,
    WrongMagicBytes,
    MetadataOutOfRange {
        offset: u32,
        size: u16,
        file_size: u32,
    },
    MetadataDecoding,
    FileTooSmall {
        num_methods: u16,
        read_only_section_size: u32,
        file_size: u32,
    },
    MethodOutOfRange {
        offset: u32,
        code_section_offset: u32,
        file_size: u32,
    },
    HostCallFnOutOfRange {
        offset: u32,
        code_section_offset: u32,
        file_size: u32,
    },
    InvalidHostCallFnPattern {
        first: Instruction,
        second: Instruction,
    },
    InvalidReadOnlySizes {
        file_size: u32,
        memory_size: u32,
    },
    InsufficientHeaderMethods {
        header_num_methods: u16,
        metadata_method_index: u16,
    },
    MetadataNumMethodsMismatch {
        header_num_methods: u16,
        metadata_num_methods: u16,
    },
    UnexpectedInstruction {
        instruction: Instruction,
    },
    UnexpectedTrailingCodeBytes {
        num_bytes: usize,
    },
}

Error for ContractFile::parse()

Variants

FileTooLarge

The file is too large, must fit into u32

Fields

file_size: usize

Actual file size

NoHeader

The file does not have a header (not enough bytes)

WrongMagicBytes

The magic bytes in the header are incorrect

MetadataOutOfRange

The metadata section is out of bounds of the file

Fields

offset: u32

Offset of the metadata section in bytes relative to the start of the file

size: u16

Size of the metadata section in bytes

file_size: u32

Size of the file in bytes

MetadataDecoding

Failed to decode metadata item

FileTooSmall

The file is too small

Fields

num_methods: u16

Number of methods in the contract

read_only_section_size: u32

Size of the read-only section in bytes as stored in the file

file_size: u32

Size of the file in bytes

MethodOutOfRange

Method offset is out of bounds of the file

Fields

offset: u32

Offset of the method in bytes relative to the start of the file

code_section_offset: u32

Offset of the code section in bytes relative to the start of the file

file_size: u32

Size of the file in bytes

HostCallFnOutOfRange

The host call function offset is out of bounds of the file

Fields

offset: u32

Offset of the host call function in bytes relative to the start of the file

code_section_offset: u32

Offset of the code section in bytes relative to the start of the file

file_size: u32

Size of the file in bytes

InvalidHostCallFnPattern

Host call function doesn’t have auipc + jalr tailcall pattern

Fields

first: Instruction

First instruction of the host call function

second: Instruction

Second instruction of the host call function

InvalidReadOnlySizes

The read-only section file size is larger than the memory size

Fields

file_size: u32

Size of the read-only section in bytes as stored in the file

memory_size: u32

Size of the read-only section in bytes as will be written to memory during execution

InsufficientHeaderMethods

There are not enough methods in the header to match the number of methods in the actual metadata

Fields

header_num_methods: u16

Number of methods in the header

metadata_method_index: u16

Index of the method in the actual metadata that is missing from the header

MetadataNumMethodsMismatch

The number of methods in the header does not match the number of methods in the actual metadata

Fields

header_num_methods: u16

Number of methods in the header

metadata_num_methods: u16

Number of methods in the actual metadata

UnexpectedInstruction

Unexpected instruction encountered while parsing the code section

Fields

instruction: Instruction

Instruction

UnexpectedTrailingCodeBytes

Unexpected trailing code bytes encountered while parsing the code section

Fields

num_bytes: usize

Number of trailing bytes encountered

Trait Implementations

impl Debug for ContractFileParseError

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

Formats the value using the given formatter.

impl Display for ContractFileParseError

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

Formats the value using the given formatter.

impl Error for ContractFileParseError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<MetadataDecodingError<'_>> for ContractFileParseError

fn from(error: MetadataDecodingError<'_>) -> Self

Converts to this type from the input type.