Struct rustc_middle::mir::coverage::ExpressionOperandId

pub struct ExpressionOperandId {
    private: u32,
}

An ExpressionOperandId value is assigned directly from either a CounterValueReference.as_u32() (which ascend from 1) or an ExpressionOperandId.as_u32() (which descend from u32::MAX). Id value 0 (zero) represents a virtual counter with a constant value of 0.

Fields

private: u32

Implementations

impl ExpressionOperandId

pub const MAX_AS_U32: u32 = 4_294_967_295u32

Maximum value the index can take, as a u32.

pub const MAX: Self = Self::from_u32(4294967295)

Maximum value the index can take.

pub const fn from_usize(value: usize) -> Self

Creates a new index from a given usize.

Panics

Will panic if value exceeds MAX.

pub const fn from_u32(value: u32) -> Self

Creates a new index from a given u32.

Panics

Will panic if value exceeds MAX.

pub const unsafe fn from_u32_unchecked(value: u32) -> Self

Creates a new index from a given u32.

Safety

The provided value must be less than or equal to the maximum value for the newtype. Providing a value outside this range is undefined due to layout restrictions.

Prefer using from_u32.

pub const fn index(self) -> usize

Extracts the value of this index as a usize.

pub const fn as_u32(self) -> u32

Extracts the value of this index as a u32.

pub const fn as_usize(self) -> usize

Extracts the value of this index as a usize.

impl ExpressionOperandId

pub const ZERO: Self = Self::from_u32(0)

An expression operand for a “zero counter”, as described in the following references:

• https://github.com/rust-lang/llvm-project/blob/rustc/13.0-2021-09-30/llvm/docs/CoverageMappingFormat.rst#counter
• https://github.com/rust-lang/llvm-project/blob/rustc/13.0-2021-09-30/llvm/docs/CoverageMappingFormat.rst#tag
• https://github.com/rust-lang/llvm-project/blob/rustc/13.0-2021-09-30/llvm/docs/CoverageMappingFormat.rst#counter-expressions

This operand can be used to count two or more separate code regions with a single counter, if they run sequentially with no branches, by injecting the Counter in a BasicBlock for one of the code regions, and inserting CounterExpressions (“add ZERO to the counter”) in the coverage map for the other code regions.

Trait Implementations

impl Add<usize> for ExpressionOperandId

type Output = ExpressionOperandId

The resulting type after applying the + operator.

fn add(self, other: usize) -> Self

Performs the + operation.

impl Clone for ExpressionOperandId

fn clone(&self) -> ExpressionOperandId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ExpressionOperandId

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

Formats the value using the given formatter.

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

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

impl<E: Encoder> Encodable<E> for ExpressionOperandId

fn encode(&self, e: &mut E) -> Result<(), E::Error>

impl From<CounterValueReference> for ExpressionOperandId

fn from(v: CounterValueReference) -> ExpressionOperandId

Converts to this type from the input type.

impl From<ExpressionOperandId> for u32

fn from(v: ExpressionOperandId) -> u32

Converts to this type from the input type.

impl From<ExpressionOperandId> for usize

fn from(v: ExpressionOperandId) -> usize

Converts to this type from the input type.

impl From<InjectedExpressionId> for ExpressionOperandId

fn from(v: InjectedExpressionId) -> ExpressionOperandId

Converts to this type from the input type.

impl From<u32> for ExpressionOperandId

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<usize> for ExpressionOperandId

fn from(value: usize) -> Self

Converts to this type from the input type.

impl Hash for ExpressionOperandId

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, 

Feeds a slice of this type into the given Hasher.

impl<'__ctx> HashStable<StableHashingContext<'__ctx>> for ExpressionOperandId

fn hash_stable(
    &self,
    __hcx: &mut StableHashingContext<'__ctx>,
    __hasher: &mut StableHasher
)

impl Idx for ExpressionOperandId

fn new(value: usize) -> Self

fn index(self) -> usize

fn increment_by(&mut self, amount: usize)

fn plus(self, amount: usize) -> Self

impl<'tcx> Lift<'tcx> for ExpressionOperandId

type Lifted = ExpressionOperandId

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

impl Ord for ExpressionOperandId

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

Restrict a value to a certain interval.

impl PartialEq<ExpressionOperandId> for ExpressionOperandId

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

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

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

This method tests for !=.

impl PartialOrd<ExpressionOperandId> for ExpressionOperandId

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

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

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

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

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

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

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

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

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

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

impl Step for ExpressionOperandId

fn steps_between(start: &Self, end: &Self) -> Option<usize>

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

Returns the number of successor steps required to get from start to end.

fn forward_checked(start: Self, u: usize) -> Option<Self>

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

Returns the value that would be obtained by taking the successor of self count times.

fn backward_checked(start: Self, u: usize) -> Option<Self>

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

Returns the value that would be obtained by taking the predecessor of self count times.

fn forward(start: Self, count: usize) -> Self

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

Returns the value that would be obtained by taking the successor of self count times.

unsafe fn forward_unchecked(start: Self, count: usize) -> Self

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

Returns the value that would be obtained by taking the successor of self count times.

fn backward(start: Self, count: usize) -> Self

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

Returns the value that would be obtained by taking the predecessor of self count times.

unsafe fn backward_unchecked(start: Self, count: usize) -> Self

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

Returns the value that would be obtained by taking the predecessor of self count times.

impl<'tcx> TypeFoldable<'tcx> for ExpressionOperandId

fn try_super_fold_with<F: FallibleTypeFolder<'tcx>>(
    self,
    _: &mut F
) -> Result<ExpressionOperandId, F::Error>

Traverses the type in question, typically by calling try_fold_with on each field/element. This is true even for types of interest such as Ty. This should only be called within TypeFolder methods, when non-custom traversals are desired for types of interest.

fn super_visit_with<F: TypeVisitor<'tcx>>(
    &self,
    _: &mut F
) -> ControlFlow<F::BreakTy>

Traverses the type in question, typically by calling visit_with on each field/element. This is true even for types of interest such as Ty. This should only be called within TypeVisitor methods, when non-custom traversals are desired for types of interest.

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

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

fn fold_with<F: TypeFolder<'tcx, Error = !>>(self, folder: &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.

fn super_fold_with<F: TypeFolder<'tcx, Error = !>>(self, folder: &mut F) -> Self

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

fn visit_with<V: TypeVisitor<'tcx>>(
    &self,
    visitor: &mut V
) -> ControlFlow<V::BreakTy>

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

fn has_vars_bound_at_or_above(&self, binder: DebruijnIndex) -> bool

Returns true if self has any late-bound regions that are either bound by binder or bound by some binder outside of binder. If binder is ty::INNERMOST, this indicates whether there are any late-bound regions that appear free.

fn has_vars_bound_above(&self, binder: DebruijnIndex) -> bool

Returns true if this self has any regions that escape binder (and hence are not bound by it).

fn has_escaping_bound_vars(&self) -> bool

fn has_type_flags(&self, flags: TypeFlags) -> bool

fn has_projections(&self) -> bool

fn has_opaque_types(&self) -> bool

fn references_error(&self) -> bool

fn error_reported(&self) -> Option<ErrorGuaranteed>

fn has_param_types_or_consts(&self) -> bool

fn has_infer_regions(&self) -> bool

fn has_infer_types(&self) -> bool

fn has_infer_types_or_consts(&self) -> bool

fn needs_infer(&self) -> bool

fn has_placeholders(&self) -> bool

fn needs_subst(&self) -> bool

fn has_free_regions(&self) -> bool

“Free” regions in this context means that it has any region that is not (a) erased or (b) late-bound.

fn has_erased_regions(&self) -> bool

fn has_erasable_regions(&self) -> bool

True if there are any un-erased free regions.

fn is_global(&self) -> bool

Indicates whether this value references only ‘global’ generic parameters that are the same regardless of what fn we are in. This is used for caching.

fn has_late_bound_regions(&self) -> bool

True if there are any late-bound regions

fn still_further_specializable(&self) -> bool

Indicates whether this value still has parameters/placeholders/inference variables which could be replaced later, in a way that would change the results of impl specialization.

impl Copy for ExpressionOperandId

impl Eq for ExpressionOperandId

impl StructuralEq for ExpressionOperandId

impl StructuralPartialEq for ExpressionOperandId

impl TrustedStep for ExpressionOperandId

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