unlikely in core::intrinsics - Rust
Description: Hints to the compiler that branch condition is likely to be false. Returns the value passed to it.
Keywords: rust, rustlang, rust-lang, unlikely

# Function core::intrinsics::unlikely
[−][src]

    pub extern "rust-intrinsic" fn unlikely(b: bool) -> bool

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

intrinsics are unlikely to ever be stabilized, instead they should be used through stabilized interfaces in the rest of the standard library

Expand description

Hints to the compiler that branch condition is likely to be false. Returns the value passed to it.

Any use other than with `if` statements will probably not have an effect.

Note that, unlike most intrinsics, this is safe to call; it does not require an `unsafe` block. Therefore, implementations must not require the user to uphold any safety invariants.

This intrinsic does not have a stable counterpart.