Skip to main content

InstKind

Enum InstKind 

Source
#[non_exhaustive]
pub enum InstKind { Plain, Copy, ParallelCopy, Jump, Branch, Return, Call, Trap, TailCall, Switch, }
Expand description

What an instruction does to control flow, and which generic handling it gets.

§Examples

use backend_lang::target::InstKind;
use backend_lang::x86_64::{self, op};

assert_eq!(x86_64::TARGET.inst(op::JMP).unwrap().kind(), InstKind::Jump);
assert!(InstKind::Jump.is_terminator());
assert!(!InstKind::Call.is_terminator());

Variants (Non-exhaustive)§

This enum is marked as non-exhaustive
Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.
§

Plain

An ordinary instruction; control falls through.

§

Copy

§

ParallelCopy

§

Jump

An unconditional branch to one block, passing arguments.

§

Branch

A two-way conditional branch: a condition, then the taken and the not-taken block, each with arguments.

§

Return

A return from the function (the epilogue runs first).

§

Call

A call; control comes back to the next instruction.

§

Trap

An instruction that never falls through and never returns (ud2).

§

TailCall

A tail call: the epilogue runs, then control jumps to the callee, which returns to this function’s caller.

§

Switch

A multi-way branch through a table: a temporary definition, an index register, then one target block per index (jmptbl). The targets take no arguments. The temporary is written before the index is last read, so the register allocator never gives the two one register.

Implementations§

Source§

impl InstKind

Source

pub const fn is_terminator(self) -> bool

Whether the instruction ends a block: jumps, branches, returns, traps, tail calls, and table branches.

§Examples
use backend_lang::target::InstKind;

assert!(InstKind::Return.is_terminator());
assert!(!InstKind::Plain.is_terminator());

Trait Implementations§

Source§

impl Clone for InstKind

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for InstKind

Source§

impl Debug for InstKind

Source§

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

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

impl Eq for InstKind

Source§

impl Hash for InstKind

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

fn hash_slice<H>(data: &[Self], state: &mut H)
where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for InstKind

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for InstKind

Auto Trait Implementations§

Blanket Implementations§

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> 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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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> 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 = !

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

fn try_from(value: U) -> Result<T, !>

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.