pub enum ExternalName {
    User {
        namespace: u32,
        index: u32,
    },
    TestCase {
        length: u8,
        ascii: [u8; 16],
    },
    LibCall(LibCall),
}
Expand description

The name of an external is either a reference to a user-defined symbol table, or a short sequence of ascii bytes so that test cases do not have to keep track of a symbol table.

External names are primarily used as keys by code using Cranelift to map from a cranelift_codegen::ir::FuncRef or similar to additional associated data.

External names can also serve as a primitive testing and debugging tool. In particular, many .clif test files use function names to identify functions.

Variants

User

Fields

namespace: u32

Arbitrary.

index: u32

Arbitrary.

A name in a user-defined symbol table. Cranelift does not interpret these numbers in any way.

TestCase

Fields

length: u8

How many of the bytes in ascii are valid?

ascii: [u8; 16]

Ascii bytes of the name.

A test case function name of up to a hardcoded amount of ascii characters. This is not intended to be used outside test cases.

LibCall(LibCall)

A well-known runtime library function.

Implementations

Creates a new external name from a sequence of bytes. Caller is expected to guarantee bytes are only ascii alphanumeric or _.

Examples
// Create `ExternalName` from a string.
let name = ExternalName::testcase("hello");
assert_eq!(name.to_string(), "%hello");

Create a new external name from user-provided integer indices.

Examples
// Create `ExternalName` from integer indices
let name = ExternalName::user(123, 456);
assert_eq!(name.to_string(), "u123:456");

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

Returns the “default value” for a type. Read more

Formats the value using the given formatter. Read more

The associated error which can be returned from parsing.

Parses a string s to return a value of this type. Read more

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

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Compare self to key and return true if they are equal.

Returns the argument unchanged.

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

Uses borrowed data to replace owned data, usually by cloning. Read more

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.