Struct rustc_codegen_ssa::coverageinfo::ffi::Counter

#[repr(C)]
pub struct Counter {
    pub kind: CounterKind,
    id: u32,
}

A reference to an instance of an abstract “counter” that will yield a value in a coverage report. Note that id has different interpretations, depending on the kind:

• For CounterKind::Zero, id is assumed to be 0
• For CounterKind::CounterValueReference, id matches the counter_id of the injected instrumentation counter (the index argument to the LLVM intrinsic instrprof.increment())
• For CounterKind::Expression, id is the index into the coverage map’s array of counter expressions. Aligns with llvm::coverage::Counter Important: The Rust struct layout (order and types of fields) must match its C++ counterpart.

Fields

kind: CounterKind

id: u32

Implementations

impl Counter

pub fn zero() -> Self

Constructs a new Counter of kind Zero. For this CounterKind, the id is not used.

pub fn counter_value_reference(counter_id: CounterValueReference) -> Self

Constructs a new Counter of kind CounterValueReference, and converts the given 1-based counter_id to the required 0-based equivalent for the Counter encoding.

pub fn expression(mapped_expression_index: MappedExpressionIndex) -> Self

Constructs a new Counter of kind Expression.

pub fn is_zero(&self) -> bool

Returns true if the Counter kind is Zero.

pub fn zero_based_id(&self) -> u32

An explicitly-named function to get the ID value, making it more obvious that the stored value is now 0-based.

Trait Implementations

impl Clone for Counter

fn clone(&self) -> Counter

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for Counter

impl Debug for Counter

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

Formats the value using the given formatter.