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 = 4_294_967_040u32

Maximum value the index can take, as a u32.

pub const MAX: Self = _

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 BasicBlock

pub fn start_location(self) -> Location

Trait Implementations

impl Add<usize> for BasicBlock

type Output = BasicBlock

The resulting type after applying the + operator.

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

Performs the + operation.

impl Clone for BasicBlock

fn clone(&self) -> BasicBlock

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BasicBlock

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

Formats the value using the given formatter.

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

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

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

fn encode(&self, e: &mut E)

impl From<BasicBlock> for u32

fn from(v: BasicBlock) -> u32

Converts to this type from the input type.

impl From<BasicBlock> for usize

fn from(v: BasicBlock) -> usize

Converts to this type from the input type.

impl From<u32> for BasicBlock

fn from(value: u32) -> Self

Converts to this type from the input type.

impl From<usize> for BasicBlock

fn from(value: usize) -> Self

Converts to this type from the input type.

impl Hash for BasicBlock

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<'__ctx> HashStable<StableHashingContext<'__ctx>> for BasicBlock

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

impl Idx for BasicBlock

fn new(value: usize) -> Self

fn index(self) -> usize

fn increment_by(&mut self, amount: usize)

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

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

type Output = BasicBlockData<'tcx>

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

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

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

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

impl Ord for BasicBlock

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Selfwhere Self: Sized + PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<BasicBlock> for BasicBlock

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<BasicBlock> for BasicBlock

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

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<TyCtxt<'tcx>> for BasicBlock

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

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

fn fold_with<F: TypeFolder<TyCtxt<'tcx>>>(self, _: &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.

impl<'tcx> TypeVisitable<TyCtxt<'tcx>> for BasicBlock

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

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

impl Copy for BasicBlock

impl Eq for BasicBlock

impl StructuralEq for BasicBlock

impl StructuralPartialEq for BasicBlock

impl TrustedStep for BasicBlock

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