Enum rustc_middle::mir::interpret::Scalar[][src]

pub enum Scalar<Tag = AllocId> {
    Int(ScalarInt),
    Ptr(Pointer<Tag>, u8),
}
Expand description

A Scalar represents an immediate, primitive value existing outside of a memory::Allocation. It is in many ways like a small chunk of an Allocation, up to 16 bytes in size. Like a range of bytes in an Allocation, a Scalar can either represent the raw bytes of a simple value or a pointer into another Allocation

These variants would be private if there was a convenient way to achieve that in Rust. Do not match on a Scalar! Use the various to_* methods instead.

Variants

Int(ScalarInt)

The raw bytes of a simple value.

Tuple Fields of Int

0: ScalarInt
Ptr(Pointer<Tag>, u8)

A pointer into an Allocation. An Allocation in the memory module has a list of relocations, but a Scalar is only large enough to contain one, so we just represent the relocation and its associated offset together as a Pointer here.

We also store the size of the pointer, such that a Scalar always knows how big it is. The size is always the pointer size of the current target, but this is not information that we always have readily available.

Tuple Fields of Ptr

0: Pointer<Tag>1: u8

Implementations

Create a Scalar from a pointer with an Option<_> tag (where None represents a plain integer).

This is almost certainly not the method you want! You should dispatch on the type and use to_{u8,u16,...}/scalar_to_ptr to perform ptr-to-int / int-to-ptr casts as needed.

This method only exists for the benefit of low-level operations that truly need to treat the scalar in whatever form it is.

Fundamental scalar-to-int (cast) operation. Many convenience wrappers exist below, that you likely want to use instead.

Will perform ptr-to-int casts if needed and possible. If that fails, we know the offset is relative, so we return an “erased” Scalar (which is useful for error messages but not much else).

This throws UB (instead of ICEing) on a size mismatch since size mismatches can arise in Miri when someone declares a function that we shim (such as malloc) with a wrong type.

Converts the scalar to produce a u8. Fails if the scalar is a pointer.

Converts the scalar to produce a u16. Fails if the scalar is a pointer.

Converts the scalar to produce a u32. Fails if the scalar is a pointer.

Converts the scalar to produce a u64. Fails if the scalar is a pointer.

Converts the scalar to produce a u128. Fails if the scalar is a pointer.

Converts the scalar to produce an i8. Fails if the scalar is a pointer.

Converts the scalar to produce an i16. Fails if the scalar is a pointer.

Converts the scalar to produce an i32. Fails if the scalar is a pointer.

Converts the scalar to produce an i64. Fails if the scalar is a pointer.

Converts the scalar to produce an i128. Fails if the scalar is a pointer.

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

Formats the value using the given formatter. Read more

Performs the conversion.

Performs the conversion.

Performs the conversion.

Performs the conversion.

Feeds this value into the given Hasher. Read more

Feeds a slice of this type into the given Hasher. Read more

This method returns an Ordering between self and other. Read more

Compares and returns the maximum of two values. Read more

Compares and returns the minimum of two values. Read more

Restrict a value to a certain interval. Read more

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

This method tests for !=.

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

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

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

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

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

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

Performs the conversion.

Performs the conversion.

The resulting type after obtaining ownership.

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

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

recently added

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.

Layout

Note: Unable to compute type layout, possibly due to this type having generic parameters. Layout can only be computed for concrete, fully-instantiated types.