Struct ScalarInt

#[repr(packed(1))]
pub struct ScalarInt {
    data: u128,
    size: NonZero<u8>,
}

The raw bytes of a simple value.

This is a packed struct in order to allow this type to be optimally embedded in enums (like Scalar).

Fields

data: u128

The first size bytes of data are the value. Do not try to read less or more bytes than that. The remaining bytes must be 0.

size: NonZero<u8>

Implementations

impl ScalarInt

pub const TRUE: ScalarInt

pub const FALSE: ScalarInt

fn raw(data: u128, size: Size) -> Self

pub fn size(self) -> Size

fn check_data(self)

Make sure the data fits in size. This is guaranteed by all constructors here, but having had this check saved us from bugs many times in the past, so keeping it around is definitely worth it.

pub fn null(size: Size) -> Self

pub fn is_null(self) -> bool

pub fn try_from_uint(i: impl Into<u128>, size: Size) -> Option<Self>

pub fn truncate_from_uint(i: impl Into<u128>, size: Size) -> (Self, bool)

Returns the truncated result, and whether truncation changed the value.

pub fn try_from_int(i: impl Into<i128>, size: Size) -> Option<Self>

pub fn truncate_from_int(i: impl Into<i128>, size: Size) -> (Self, bool)

Returns the truncated result, and whether truncation changed the value.

pub fn try_from_target_usize( i: impl Into<u128>, tcx: TyCtxt<'_>, ) -> Option<Self>

pub fn try_to_bits(self, target_size: Size) -> Result<u128, Size>

Try to convert this ScalarInt to the raw underlying bits. Fails if the size is wrong. Generally a wrong size should lead to a panic, but Miri sometimes wants to be resilient to size mismatches, so the interpreter will generally use this try method.

pub fn to_bits(self, target_size: Size) -> u128

pub fn to_bits_unchecked(self) -> u128

Extracts the bits from the scalar without checking the size.

pub fn to_uint(self, size: Size) -> u128

Converts the ScalarInt to an unsigned integer of the given size. Panics if the size of the ScalarInt is not equal to size.

pub fn to_u8(self) -> u8

Converts the ScalarInt to u8. Panics if the size of the ScalarIntin not equal to 1 byte.

pub fn to_u16(self) -> u16

Converts the ScalarInt to u16. Panics if the size of the ScalarInt in not equal to 2 bytes.

pub fn to_u32(self) -> u32

Converts the ScalarInt to u32. Panics if the size of the ScalarInt in not equal to 4 bytes.

pub fn to_u64(self) -> u64

Converts the ScalarInt to u64. Panics if the size of the ScalarInt in not equal to 8 bytes.

pub fn to_u128(self) -> u128

Converts the ScalarInt to u128. Panics if the size of the ScalarInt in not equal to 16 bytes.

pub fn to_target_usize(&self, tcx: TyCtxt<'_>) -> u64

pub fn try_to_bool(self) -> Result<bool, ()>

Converts the ScalarInt to bool. Panics if the size of the ScalarInt is not equal to 1 byte. Errors if it is not a valid bool.

pub fn to_int(self, size: Size) -> i128

Converts the ScalarInt to a signed integer of the given size. Panics if the size of the ScalarInt is not equal to size.

pub fn to_i8(self) -> i8

Converts the ScalarInt to i8. Panics if the size of the ScalarInt is not equal to 1 byte.

pub fn to_i16(self) -> i16

Converts the ScalarInt to i16. Panics if the size of the ScalarInt is not equal to 2 bytes.

pub fn to_i32(self) -> i32

Converts the ScalarInt to i32. Panics if the size of the ScalarInt is not equal to 4 bytes.

pub fn to_i64(self) -> i64

Converts the ScalarInt to i64. Panics if the size of the ScalarInt is not equal to 8 bytes.

pub fn to_i128(self) -> i128

Converts the ScalarInt to i128. Panics if the size of the ScalarInt is not equal to 16 bytes.

pub fn to_target_isize(&self, tcx: TyCtxt<'_>) -> i64

pub fn to_float<F: Float>(self) -> F

pub fn to_f16(self) -> Half

pub fn to_f32(self) -> Single

pub fn to_f64(self) -> Double

pub fn to_f128(self) -> Quad

Trait Implementations

impl Clone for ScalarInt

fn clone(&self) -> ScalarInt

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ScalarInt

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

Formats the value using the given formatter.

impl<D: Decoder> Decodable<D> for ScalarInt

fn decode(d: &mut D) -> ScalarInt

impl Display for ScalarInt

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

Formats the value using the given formatter.

impl<S: Encoder> Encodable<S> for ScalarInt

fn encode(&self, s: &mut S)

impl From<IeeeFloat<DoubleS>> for ScalarInt

fn from(f: Double) -> Self

Converts to this type from the input type.

impl From<IeeeFloat<HalfS>> for ScalarInt

fn from(f: Half) -> Self

Converts to this type from the input type.

impl From<IeeeFloat<QuadS>> for ScalarInt

fn from(f: Quad) -> Self

Converts to this type from the input type.

impl From<IeeeFloat<SingleS>> for ScalarInt

fn from(f: Single) -> Self

Converts to this type from the input type.

impl From<ScalarInt> for Double

fn from(int: ScalarInt) -> Self

Converts to this type from the input type.

impl From<ScalarInt> for Half

fn from(int: ScalarInt) -> Self

Converts to this type from the input type.

impl From<ScalarInt> for Quad

fn from(int: ScalarInt) -> Self

Converts to this type from the input type.

impl From<ScalarInt> for Single

fn from(int: ScalarInt) -> Self

Converts to this type from the input type.

impl<Prov> From<ScalarInt> for Scalar<Prov>

fn from(ptr: ScalarInt) -> Self

Converts to this type from the input type.

impl From<ScalarInt> for u128

fn from(int: ScalarInt) -> Self

Converts to this type from the input type.

impl From<ScalarInt> for u16

fn from(int: ScalarInt) -> Self

Converts to this type from the input type.

impl From<ScalarInt> for u32

fn from(int: ScalarInt) -> Self

Converts to this type from the input type.

impl From<ScalarInt> for u64

fn from(int: ScalarInt) -> Self

Converts to this type from the input type.

impl From<ScalarInt> for u8

fn from(int: ScalarInt) -> Self

Converts to this type from the input type.

impl From<bool> for ScalarInt

fn from(u: bool) -> Self

Converts to this type from the input type.

impl From<char> for ScalarInt

fn from(c: char) -> Self

Converts to this type from the input type.

impl From<u128> for ScalarInt

fn from(u: u128) -> Self

Converts to this type from the input type.

impl From<u16> for ScalarInt

fn from(u: u16) -> Self

Converts to this type from the input type.

impl From<u32> for ScalarInt

fn from(u: u32) -> Self

Converts to this type from the input type.

impl From<u64> for ScalarInt

fn from(u: u64) -> Self

Converts to this type from the input type.

impl From<u8> for ScalarInt

fn from(u: u8) -> Self

Converts to this type from the input type.

impl Hash for ScalarInt

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<CTX> HashStable<CTX> for ScalarInt

fn hash_stable(&self, hcx: &mut CTX, hasher: &mut StableHasher)

impl LowerHex for ScalarInt

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

Formats the value using the given formatter.

impl PartialEq for ScalarInt

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl TryFrom<ScalarInt> for bool

type Error = ()

The type returned in the event of a conversion error.

fn try_from(int: ScalarInt) -> Result<Self, ()>

Performs the conversion.

impl TryFrom<ScalarInt> for char

type Error = CharTryFromScalarInt

The type returned in the event of a conversion error.

fn try_from(int: ScalarInt) -> Result<Self, Self::Error>

Performs the conversion.

impl UpperHex for ScalarInt

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

Formats the value using the given formatter.

impl Copy for ScalarInt

impl Eq for ScalarInt

impl StructuralPartialEq for ScalarInt

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 17 bytes