Enum Predictor 

pub enum Predictor {
    Expect,
    NeverReturns,
    ColdCall,
    LoopExit,
    LoopGuard,
    PointerNotNull,
    NegativeReturn,
    NullReturn,
    CallNotTaken,
    Continue,
    Nothing,
}

Which predictor decided a branch.

In the order they are asked, which is section 11.2’s order, so a comparison between two of these says which one wins where both apply.

Variants

Expect

__builtin_expect named an arm.

NeverReturns

One arm does not come back.

ColdCall

One arm calls a function the user marked cold.

LoopExit

One arm leaves the loop and the other stays in it.

LoopGuard

The branch decides whether to run a loop at all.

PointerNotNull

The condition compares a pointer against null.

NegativeReturn

One arm returns a negative constant.

NullReturn

One arm returns a null pointer.

CallNotTaken

One arm contains a call and the other does not.

Continue

One arm goes back to the top of the loop.

Nothing

Nothing applied, so the arms are even.

Implementations

impl Predictor

pub const ORDER: [Self; 10]

The ten, in the order they are asked.

pub const fn as_str(self) -> &'static str

How it reads in a dump.

pub const fn hit_rate(self) -> u32

The rate at which it was measured right, in percent, and fifty for no prediction at all.

Trait Implementations

impl Clone for Predictor

fn clone(&self) -> Predictor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Predictor

impl Debug for Predictor

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

Formats the value using the given formatter.

impl Display for Predictor

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

Formats the value using the given formatter.

impl Eq for Predictor

impl Hash for Predictor

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 Ord for Predictor

fn cmp(&self, other: &Predictor) -> 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.

fn clamp_to<R>(self, range: R) -> Self

where Self: Sized, R: ClampBounds<Self>,

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

Restrict a value to a certain range.

impl PartialEq for Predictor

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

Equality operator ==.

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

Inequality operator !=.

impl PartialOrd for Predictor

fn partial_cmp(&self, other: &Predictor) -> 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 StructuralPartialEq for Predictor