Struct rustc_middle::mir::BasicBlock

pub struct BasicBlock {
    private: u32,
}

A node in the MIR control-flow graph.

There are no branches (e.g., ifs, function calls, etc.) within a basic block, which makes it easier to do data-flow analyses and optimizations. Instead, branches are represented as an edge in a graph between basic blocks.

Basic blocks consist of a series of statements, ending with a terminator. Basic blocks can have multiple predecessors and successors, however there is a MIR pass (CriticalCallEdges) that removes critical edges, which are edges that go from a multi-successor node to a multi-predecessor node. This pass is needed because some analyses require that there are no critical edges in the CFG.

Note that this type is just an index into Body.basic_blocks; the actual data that a basic block holds is in BasicBlockData.

Read more about basic blocks in the rustc-dev-guide.

Fields

private: u32

Implementations

impl BasicBlock

pub const MAX_AS_U32: u32

pub const MAX: Self

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

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

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

pub const fn index(self) -> usize

Extracts the value of this index as an integer.

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 BasicBlock

pub fn start_location(self) -> Location

Trait Implementations

impl Add<usize> for BasicBlock

type Output = Self

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for BasicBlock

pub fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for BasicBlock

impl Debug for BasicBlock

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

Formats the value using the given formatter.

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

pub fn decode(d: &mut D) -> Result<Self, D::Error>

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

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

impl Eq for BasicBlock

impl From<u32> for BasicBlock

pub fn from(value: u32) -> Self

Performs the conversion.

impl From<usize> for BasicBlock

pub fn from(value: usize) -> Self

Performs the conversion.

impl Hash for BasicBlock

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub 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 BasicBlock

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

impl Idx for BasicBlock

pub fn new(value: usize) -> Self

pub fn index(self) -> usize

pub fn increment_by(&mut self, amount: usize)

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

impl<'tcx> Index<BasicBlock> for Body<'tcx>

type Output = BasicBlockData<'tcx>

The returned type after indexing.

pub fn index(&self, index: BasicBlock) -> &BasicBlockData<'tcx>

Performs the indexing (container[index]) operation.

impl<'tcx> IndexMut<BasicBlock> for Body<'tcx>

pub fn index_mut(&mut self, index: BasicBlock) -> &mut BasicBlockData<'tcx>

Performs the mutable indexing (container[index]) operation.

impl Ord for BasicBlock

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

This method returns an Ordering between self and other.

#[must_use]pub fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]pub fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]pub fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl PartialEq<BasicBlock> for BasicBlock

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

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

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

This method tests for !=.

impl PartialOrd<BasicBlock> for BasicBlock

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

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

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

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

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

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

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

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

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

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

impl Step for BasicBlock

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

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

recently redesigned

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

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

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

recently added

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

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

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

recently added

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

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

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

recently added

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

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

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

niche optimization path

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

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

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

recently added

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

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

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

niche optimization path

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

impl StructuralEq for BasicBlock

impl StructuralPartialEq for BasicBlock