TerminatorKind in rustc_public::mir::body - Rust
Description: API documentation for the Rust `TerminatorKind` enum in crate `rustc_public`.

Skip to main content

## TerminatorKind

# Enum TerminatorKind

Source

    pub enum TerminatorKind {
        Goto {
            target: BasicBlockIdx,
        },
        SwitchInt {
            discr: Operand,
            targets: SwitchTargets,
        },
        Resume,
        Abort,
        Return,
        Unreachable,
        Drop {
            place: Place,
            target: BasicBlockIdx,
            unwind: UnwindAction,
        },
        Call {
            func: Operand,
            args: Vec<Operand>,
            destination: Place,
            target: Option<BasicBlockIdx>,
            unwind: UnwindAction,
        },
        Assert {
            cond: Operand,
            expected: bool,
            msg: AssertMessage,
            target: BasicBlockIdx,
            unwind: UnwindAction,
        },
        InlineAsm {
            template: String,
            operands: Vec<InlineAsmOperand>,
            options: String,
            line_spans: String,
            destination: Option<BasicBlockIdx>,
            unwind: UnwindAction,
        },
    }

## Variants§

§

### Goto

#### Fields

§`target: BasicBlockIdx`
§

### SwitchInt

#### Fields

§`discr: Operand`
§`targets: SwitchTargets`
§

### Resume

§

### Abort

§

### Return

§

### Unreachable

§

### Drop

#### Fields

§`place: Place`
§`target: BasicBlockIdx`
§`unwind: UnwindAction`
§

### Call

#### Fields

§`func: Operand`
§`args: Vec<Operand>`
§`destination: Place`
§`target: Option<BasicBlockIdx>`
§`unwind: UnwindAction`
§

### Assert

#### Fields

§`cond: Operand`
§`expected: bool`
§`msg: AssertMessage`
§`target: BasicBlockIdx`
§`unwind: UnwindAction`
§

### InlineAsm

#### Fields

§`template: String`
§`operands: Vec<InlineAsmOperand>`
§`options: String`
§`line_spans: String`
§`destination: Option<BasicBlockIdx>`
§`unwind: UnwindAction`

## Implementations§

Source§

### impl TerminatorKind

Source

#### pub fn successors(&self) -> Successors

Source

#### pub fn unwind(&self) -> Option<&UnwindAction>

## Trait Implementations§

Source§

### impl Clone for TerminatorKind

Source§

#### fn clone(&self) -> TerminatorKind

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from `source`. Read more
Source§

### impl Debug for TerminatorKind

Source§

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

Formats the value using the given formatter. Read more
Source§

### impl PartialEq for TerminatorKind

Source§

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

Tests for `self` and `other` values to be equal, and is used by `==`.
1.0.0 · Source§

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

Tests for `!=`. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

### impl Serialize for TerminatorKind

Source§

#### fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

### impl Eq for TerminatorKind

Source§

### impl StructuralPartialEq for TerminatorKind

## Auto Trait Implementations§

§

### impl !DynSend for TerminatorKind

§

### impl !DynSync for TerminatorKind

§

### impl Freeze for TerminatorKind

§

### impl RefUnwindSafe for TerminatorKind

§

### impl !Send for TerminatorKind

§

### impl !Sync for TerminatorKind

§

### impl Unpin for TerminatorKind

§

### impl UnsafeUnpin for TerminatorKind

§

### impl UnwindSafe for TerminatorKind

## Blanket Implementations§

Source§

### impl<T> Aligned for T

Source§

#### const ALIGN: Alignment

Alignment of `Self`.
Source§

### impl<T> Any for T
where T: 'static + ?Sized,

Source§

#### fn type_id(&self) -> TypeId

Gets the `TypeId` of `self`. Read more
Source§

### impl<T> AnyEq for T
where T: Any + PartialEq,

Source§

#### fn equals(&self, other: &(dyn Any + 'static)) -> bool

Source§

#### fn as_any(&self) -> &(dyn Any + 'static)

Source§

### impl<T> Borrow<T> for T
where T: ?Sized,

Source§

#### fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

### impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

#### fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

### impl<T> CloneToUninit for T
where T: Clone,

Source§

#### unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (`clone_to_uninit`)
Performs copy-assignment from `self` to `dest`. Read more
Source§

### impl<T, R> CollectAndApply<T, R> for T

Source§

#### fn collect_and_apply<I, F>(iter: I, f: F) -> R
where I: Iterator<Item = T>, F: FnOnce(&[T]) -> R,

Equivalent to `f(&iter.collect::<Vec<_>>())`.

Source§

#### type Output = R

Source§

### impl<T> DynClone for T
where T: Clone,

Source§

#### fn __clone_box(&self, _: Private) -> *mut ()

Source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

#### fn equivalent(&self, key: &K) -> bool

Checks if this value is equivalent to the given key. Read more
Source§

### impl<Q, K> Equivalent<K> for Q
where Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

Source§

#### fn equivalent(&self, key: &K) -> bool

Compare self to `key` and return `true` if they are equal.
Source§

### impl<T> From<T> for T

Source§

#### fn from(t: T) -> T

Returns the argument unchanged.

Source§

### impl<T> Instrument for T

Source§

#### fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided `Span`, returning an `Instrumented` wrapper. Read more
Source§

#### fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current `Span`, returning an `Instrumented` wrapper. Read more
Source§

### impl<T, U> Into<U> for T
where U: From<T>,

Source§

#### fn into(self) -> U

Calls `U::from(self)`.

That is, this conversion is whatever the implementation of `From<T> for U` chooses to do.

Source§

### impl<T> IntoEither for T

Source§

#### fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left` is `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

#### fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts `self` into a `Left` variant of `Either<Self, Self>` if `into_left(&self)` returns `true`. Converts `self` into a `Right` variant of `Either<Self, Self>` otherwise. Read more
Source§

### impl<K> IntoQueryKey<K> for K

Source§

#### fn into_query_key(self) -> K

Argument conversion from `Self` to `K`. This should always be a very cheap conversion, e.g. `LocalDefId::to_def_id`.
Source§

### impl<T> MaybeResult<T> for T

Source§

#### type Error = !

Source§

#### fn from(_: Result<T, <T as MaybeResult<T>>::Error>) -> T

Source§

#### fn to_result(self) -> Result<T, <T as MaybeResult<T>>::Error>

Source§

### impl<T> Pointable for T

Source§

#### const ALIGN: usize

The alignment of pointer.
Source§

#### type Init = T

The type for initializers.
Source§

#### unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

#### unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

#### unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

#### unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

### impl<T> Same for T

Source§

#### type Output = T

Should always be `Self`
Source§

### impl<T> ToOwned for T
where T: Clone,

Source§

#### type Owned = T

The resulting type after obtaining ownership.
Source§

#### fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

#### fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

### impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

#### type Error = Infallible

The type returned in the event of a conversion error.
Source§

#### fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

### impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

#### type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

#### fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

### impl<I, T, U> Upcast<I, U> for T
where U: UpcastFrom<I, T>,

Source§

#### fn upcast(self, interner: I) -> U

Source§

### impl<I, T> UpcastFrom<I, T> for T

Source§

#### fn upcast_from(from: T, _tcx: I) -> T

Source§

### impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

#### fn vzip(self) -> V

Source§

### impl<T> WithSubscriber for T

Source§

#### fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
Source§

#### fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default `Subscriber` to this type, returning a `WithDispatch` wrapper. Read more
Source§

### impl<T> ErasedDestructor for T
where T: 'static,

## 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: 400 bytes

Size for each variant:

- `Goto`: 16 bytes
- `SwitchInt`: 160 bytes
- `Resume`: 0 bytes
- `Abort`: 0 bytes
- `Return`: 0 bytes
- `Unreachable`: 0 bytes
- `Drop`: 64 bytes
- `Call`: 216 bytes
- `Assert`: 400 bytes
- `InlineAsm`: 136 bytes