Enum faerie::Decl

pub enum Decl {
    Import(ImportKind),
    Defined(DefinedDecl),
}

The kind of declaration this is

Variants

Import(ImportKind)

Declaration of an import

Defined(DefinedDecl)

Declaration of an item to be defined in this artifact

Methods

impl Decl

pub fn function_import() -> FunctionImportDecl

An import of a function/routine defined in a shared library

pub fn data_import() -> DataImportDecl

A GOT-based import of data defined in a shared library

pub fn function() -> FunctionDecl

A function defined in this artifact

pub fn data() -> DataDecl

A data object defined in this artifact

pub fn cstring() -> DataDecl

A null-terminated string object defined in this artifact

pub fn debug_section() -> DebugSectionDecl

A DWARF debug section defined in this artifact

pub fn absorb(&mut self, other: Self) -> Result<(), ArtifactError>

If it is compatible, absorb the new declaration (other) into the old (self); otherwise returns an error.

The rule here is "C-ish", but essentially:

1. Duplicate declarations are no-ops / ignored.
2. If the previous declaration was an FunctionImport or DataImport, then if the subsequent declaration is a corresponding matching Function or Data declaration, it is said to be "upgraded", and forever after is considered a declaration in need of a definition.
3. If the previous declaration was a Function or Data declaration, then a subsequent corresponding FunctionImport or DataImport is a no-op.
4. Anything else is a IncompatibleDeclaration error!

pub fn is_import(&self) -> bool

Is this an import (function or data) from a shared library?

pub fn is_section(&self) -> bool

Is this a section?

Trait Implementations

impl Clone for Decl

fn clone(&self) -> Decl

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for Decl

fn cmp(&self, other: &Decl) -> Ordering

This method returns an Ordering between self and other.

default fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

default fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

default fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl Eq for Decl

impl Into<Decl> for FunctionImportDecl

fn into(self) -> Decl

Performs the conversion.

impl Into<Decl> for DataImportDecl

fn into(self) -> Decl

Performs the conversion.

impl Into<Decl> for FunctionDecl

fn into(self) -> Decl

Performs the conversion.

impl Into<Decl> for DataDecl

fn into(self) -> Decl

Performs the conversion.

impl Into<Decl> for DebugSectionDecl

fn into(self) -> Decl

Performs the conversion.

impl PartialOrd<Decl> for Decl

fn partial_cmp(&self, other: &Decl) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Decl) -> bool

This method tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Decl) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Decl) -> bool

This method tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Decl) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for Decl

impl PartialEq<Decl> for Decl

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

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

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

This method tests for !=.

impl Debug for Decl

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

Formats the value using the given formatter.