Struct CtfeProvenance

pub struct CtfeProvenance(NonZero<u64>);

The type of provenance in the compile-time interpreter. This is a packed representation of:

• an AllocId (non-zero)
• an immutable: bool
• a shared_ref: bool

with the extra invariant that if immutable is true, then so is shared_ref.

Tuple Fields

0: NonZero<u64>

Implementations

impl CtfeProvenance

pub fn alloc_id(self) -> AllocId

Returns the AllocId of this provenance.

pub fn immutable(self) -> bool

Returns whether this provenance is immutable.

pub fn shared_ref(self) -> bool

Returns whether this provenance is derived from a shared reference.

pub fn into_parts(self) -> (AllocId, bool, bool)

pub fn from_parts( (alloc_id, immutable, shared_ref): (AllocId, bool, bool), ) -> Self

pub fn as_immutable(self) -> Self

Returns an immutable version of this provenance.

pub fn as_shared_ref(self) -> Self

Returns a “shared reference” (but not necessarily immutable!) version of this provenance.

Trait Implementations

impl Clone for CtfeProvenance

fn clone(&self) -> CtfeProvenance

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for CtfeProvenance

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

Formats the value using the given formatter.

impl<'tcx, D: TyDecoder<I = TyCtxt<'tcx>>> Decodable<D> for CtfeProvenance

fn decode(decoder: &mut D) -> Self

impl<'tcx, E: TyEncoder<I = TyCtxt<'tcx>>> Encodable<E> for CtfeProvenance

fn encode(&self, e: &mut E)

impl EraseType for CtfeProvenance

type Result = [u8; 8]

impl From<AllocId> for CtfeProvenance

fn from(value: AllocId) -> Self

Converts to this type from the input type.

impl From<CtfeProvenance> for Pointer

fn from(prov: CtfeProvenance) -> Self

Converts to this type from the input type.

impl Hash for CtfeProvenance

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<'a> HashStable<StableHashingContext<'a>> for CtfeProvenance

fn hash_stable( &self, hcx: &mut StableHashingContext<'a>, hasher: &mut StableHasher, )

impl<'tcx> Lift<TyCtxt<'tcx>> for CtfeProvenance

type Lifted = CtfeProvenance

fn lift_to_interner(self, _: TyCtxt<'tcx>) -> Option<Self>

impl Ord for CtfeProvenance

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

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for CtfeProvenance

fn eq(&self, other: &CtfeProvenance) -> 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 PartialOrd for CtfeProvenance

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

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl Provenance for CtfeProvenance

const OFFSET_IS_ADDR: bool = false

Says whether the offset field of Pointers with this provenance is the actual physical address.

const WILDCARD: Option<Self> = None

If wildcard provenance is implemented, contains the unique, general wildcard provenance variant.

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

Determines how a pointer should be printed.

fn get_alloc_id(self) -> Option<AllocId>

If OFFSET_IS_ADDR == false, provenance must always be able to identify the allocation this ptr points to (i.e., this must return Some). Otherwise this function is best-effort (but must agree with Machine::ptr_get_alloc). (Identifying the offset in that allocation, however, is harder – use Memory::ptr_get_alloc for that.)

fn join(_left: Option<Self>, _right: Option<Self>) -> Option<Self>

Defines the ‘join’ of provenance: what happens when doing a pointer load and different bytes have different provenance.

impl<'tcx> TypeFoldable<TyCtxt<'tcx>> for CtfeProvenance

fn try_fold_with<F: FallibleTypeFolder<TyCtxt<'tcx>>>( self, _: &mut F, ) -> Result<Self, F::Error>

The entry point for folding. To fold a value t with a folder f call: t.try_fold_with(f).

fn fold_with<F: TypeFolder<TyCtxt<'tcx>>>(self, _: &mut F) -> Self

A convenient alternative to try_fold_with for use with infallible folders. Do not override this method, to ensure coherence with try_fold_with.

impl<'tcx> TypeVisitable<TyCtxt<'tcx>> for CtfeProvenance

fn visit_with<F: TypeVisitor<TyCtxt<'tcx>>>(&self, _: &mut F) -> F::Result

The entry point for visiting. To visit a value t with a visitor v call: t.visit_with(v).

impl Copy for CtfeProvenance

impl Eq for CtfeProvenance

impl StructuralPartialEq for CtfeProvenance

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: 8 bytes