Enum rustc::mir::TerminatorKind

pub enum TerminatorKind<'tcx> {
    Goto {
        target: BasicBlock,
    },
    SwitchInt {
        discr: Operand<'tcx>,
        switch_ty: Ty<'tcx>,
        values: Cow<'tcx, [ConstInt]>,
        targets: Vec<BasicBlock>,
    },
    Resume,
    Return,
    Unreachable,
    Drop {
        location: Place<'tcx>,
        target: BasicBlock,
        unwind: Option<BasicBlock>,
    },
    DropAndReplace {
        location: Place<'tcx>,
        value: Operand<'tcx>,
        target: BasicBlock,
        unwind: Option<BasicBlock>,
    },
    Call {
        func: Operand<'tcx>,
        args: Vec<Operand<'tcx>>,
        destination: Option<(Place<'tcx>, BasicBlock)>,
        cleanup: Option<BasicBlock>,
    },
    Assert {
        cond: Operand<'tcx>,
        expected: bool,
        msg: AssertMessage<'tcx>,
        target: BasicBlock,
        cleanup: Option<BasicBlock>,
    },
    Yield {
        value: Operand<'tcx>,
        resume: BasicBlock,
        drop: Option<BasicBlock>,
    },
    GeneratorDrop,
    FalseEdges {
        real_target: BasicBlock,
        imaginary_targets: Vec<BasicBlock>,
    },
}

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Variants

Goto

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

block should have one successor in the graph; we jump there

Fields of Goto

target: BasicBlock

🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

SwitchInt

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

operand evaluates to an integer; jump depending on its value to one of the targets, and otherwise fallback to otherwise

Fields of SwitchInt

discr: Operand<'tcx>	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead? discriminant value being tested
switch_ty: Ty<'tcx>	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead? type of value being tested
values: Cow<'tcx, [ConstInt]>	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead? Possible values. The locations to branch to in each case are found in the corresponding indices from the targets vector.
targets: Vec<BasicBlock>	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead? Possible branch sites. The last element of this vector is used for the otherwise branch, so targets.len() == values.len() + 1 should hold.

Resume

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Indicates that the landing pad is finished and unwinding should continue. Emitted by build::scope::diverge_cleanup.

Return

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Indicates a normal return. The return place should have been filled in by now. This should occur at most once.

Unreachable

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Indicates a terminator that can never be reached.

Drop

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Drop the Place

Fields of Drop

location: Place<'tcx>	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?
target: BasicBlock	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?
unwind: Option<BasicBlock>	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

DropAndReplace

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Drop the Place and assign the new value over it. This ensures that the assignment to LV occurs even if the destructor for place unwinds. Its semantics are best explained by by the elaboration:

BB0 {
  DropAndReplace(LV <- RV, goto BB1, unwind BB2)
}

becomes

BB0 {
  Drop(LV, goto BB1, unwind BB2)
}
BB1 {
  // LV is now unitialized
  LV <- RV
}
BB2 {
  // LV is now unitialized -- its dtor panicked
  LV <- RV
}

Fields of DropAndReplace

location: Place<'tcx>	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?
value: Operand<'tcx>	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?
target: BasicBlock	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?
unwind: Option<BasicBlock>	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Call

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Block ends with a call of a converging function

Fields of Call

func: Operand<'tcx>	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead? The function that’s being called
args: Vec<Operand<'tcx>>	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead? Arguments the function is called with. These are owned by the callee, which is free to modify them. This allows the memory occupied by "by-value" arguments to be reused across function calls without duplicating the contents.
destination: Option<(Place<'tcx>, BasicBlock)>	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead? Destination for the return value. If some, the call is converging.
cleanup: Option<BasicBlock>	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead? Cleanups to be done if the call unwinds.

Assert

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Jump to the target if the condition has the expected value, otherwise panic with a message and a cleanup target.

Fields of Assert

cond: Operand<'tcx>	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?
expected: bool	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?
msg: AssertMessage<'tcx>	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?
target: BasicBlock	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?
cleanup: Option<BasicBlock>	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Yield

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

A suspend point

Fields of Yield

value: Operand<'tcx>	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead? The value to return
resume: BasicBlock	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead? Where to resume to
drop: Option<BasicBlock>	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead? Cleanup to be done if the generator is dropped at this suspend point

GeneratorDrop

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Indicates the end of the dropping of a generator

FalseEdges

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Fields of FalseEdges

real_target: BasicBlock	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?
imaginary_targets: Vec<BasicBlock>	🔬 This is a nightly-only experimental API. (rustc_private) this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Methods

impl<'tcx> TerminatorKind<'tcx>

pub fn if_<'a, 'gcx>(
    tcx: TyCtxt<'a, 'gcx, 'tcx>,
    cond: Operand<'tcx>,
    t: BasicBlock,
    f: BasicBlock
) -> TerminatorKind<'tcx>

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

pub fn successors(&self) -> Cow<[BasicBlock]>

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Important traits for Vec<u8>

impl Write for Vec<u8>

pub fn successors_mut(&mut self) -> Vec<&mut BasicBlock>

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

pub fn unwind_mut(&mut self) -> Option<&mut Option<BasicBlock>>

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

impl<'tcx> TerminatorKind<'tcx>

pub fn fmt_head<W: Write>(&self, fmt: &mut W) -> Result

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Write the "head" part of the terminator; that is, its name and the data it uses to pick the successor basic block, if any. The only information not included is the list of possible successors, which may be rendered differently between the text and the graphviz format.

Important traits for Vec<u8>

impl Write for Vec<u8>

pub fn fmt_successor_labels(&self) -> Vec<Cow<'static, str>>

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

Return the list of labels for the edges to the successor basic blocks.

Trait Implementations

impl<'gcx> HashStable<StableHashingContext<'gcx>> for TerminatorKind<'gcx>

fn hash_stable<W: StableHasherResult>(
    &self,
    hcx: &mut StableHashingContext<'gcx>,
    hasher: &mut StableHasher<W>
)

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

impl<'tcx> Clone for TerminatorKind<'tcx>

fn clone(&self) -> TerminatorKind<'tcx>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'tcx> Encodable for TerminatorKind<'tcx>

fn encode<__S: Encoder>(&self, __arg_0: &mut __S) -> Result<(), __S::Error>

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

impl<'tcx> Decodable for TerminatorKind<'tcx>

fn decode<__D: Decoder>(
    __arg_0: &mut __D
) -> Result<TerminatorKind<'tcx>, __D::Error>

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

this crate is being loaded from the sysroot, an unstable location; did you mean to load this crate from crates.io via Cargo.toml instead?

impl<'tcx> Debug for TerminatorKind<'tcx>

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

Formats the value using the given formatter.