Enum Instruction

Source

pub enum Instruction {
Show 238 variants    Nop,
    Assert,
    AssertWithError(Immediate<Arc<str>>),
    AssertEq,
    AssertEqWithError(Immediate<Arc<str>>),
    AssertEqw,
    AssertEqwWithError(Immediate<Arc<str>>),
    Assertz,
    AssertzWithError(Immediate<Arc<str>>),
    Add,
    AddImm(Immediate<Felt>),
    Sub,
    SubImm(Immediate<Felt>),
    Mul,
    MulImm(Immediate<Felt>),
    Div,
    DivImm(Immediate<Felt>),
    Neg,
    ILog2,
    Inv,
    Incr,
    Pow2,
    Exp,
    ExpImm(Immediate<Felt>),
    ExpBitLength(u8),
    Not,
    And,
    Or,
    Xor,
    Eq,
    EqImm(Immediate<Felt>),
    Neq,
    NeqImm(Immediate<Felt>),
    Eqw,
    Lt,
    Lte,
    Gt,
    Gte,
    IsOdd,
    Ext2Add,
    Ext2Sub,
    Ext2Mul,
    Ext2Div,
    Ext2Neg,
    Ext2Inv,
    U32Test,
    U32TestW,
    U32Assert,
    U32AssertWithError(Immediate<Arc<str>>),
    U32Assert2,
    U32Assert2WithError(Immediate<Arc<str>>),
    U32AssertW,
    U32AssertWWithError(Immediate<Arc<str>>),
    U32Split,
    U32Cast,
    U32WrappingAdd,
    U32WrappingAddImm(Immediate<u32>),
    U32OverflowingAdd,
    U32OverflowingAddImm(Immediate<u32>),
    U32WideningAdd,
    U32WideningAddImm(Immediate<u32>),
    U32OverflowingAdd3,
    U32WideningAdd3,
    U32WrappingAdd3,
    U32WrappingSub,
    U32WrappingSubImm(Immediate<u32>),
    U32OverflowingSub,
    U32OverflowingSubImm(Immediate<u32>),
    U32WrappingMul,
    U32WrappingMulImm(Immediate<u32>),
    U32WideningMul,
    U32WideningMulImm(Immediate<u32>),
    U32WideningMadd,
    U32WrappingMadd,
    U32Div,
    U32DivImm(Immediate<u32>),
    U32Mod,
    U32ModImm(Immediate<u32>),
    U32DivMod,
    U32DivModImm(Immediate<u32>),
    U32And,
    U32Or,
    U32Xor,
    U32Not,
    U32Shr,
    U32ShrImm(Immediate<u8>),
    U32Shl,
    U32ShlImm(Immediate<u8>),
    U32Rotr,
    U32RotrImm(Immediate<u8>),
    U32Rotl,
    U32RotlImm(Immediate<u8>),
    U32Popcnt,
    U32Ctz,
    U32Clz,
    U32Clo,
    U32Cto,
    U32Lt,
    U32Lte,
    U32Gt,
    U32Gte,
    U32Min,
    U32Max,
    Drop,
    DropW,
    PadW,
    Dup0,
    Dup1,
    Dup2,
    Dup3,
    Dup4,
    Dup5,
    Dup6,
    Dup7,
    Dup8,
    Dup9,
    Dup10,
    Dup11,
    Dup12,
    Dup13,
    Dup14,
    Dup15,
    DupW0,
    DupW1,
    DupW2,
    DupW3,
    Swap1,
    Swap2,
    Swap3,
    Swap4,
    Swap5,
    Swap6,
    Swap7,
    Swap8,
    Swap9,
    Swap10,
    Swap11,
    Swap12,
    Swap13,
    Swap14,
    Swap15,
    SwapW1,
    SwapW2,
    SwapW3,
    SwapDw,
    MovUp2,
    MovUp3,
    MovUp4,
    MovUp5,
    MovUp6,
    MovUp7,
    MovUp8,
    MovUp9,
    MovUp10,
    MovUp11,
    MovUp12,
    MovUp13,
    MovUp14,
    MovUp15,
    MovUpW2,
    MovUpW3,
    MovDn2,
    MovDn3,
    MovDn4,
    MovDn5,
    MovDn6,
    MovDn7,
    MovDn8,
    MovDn9,
    MovDn10,
    MovDn11,
    MovDn12,
    MovDn13,
    MovDn14,
    MovDn15,
    MovDnW2,
    MovDnW3,
    Reversew,
    Reversedw,
    CSwap,
    CSwapW,
    CDrop,
    CDropW,
    Push(Immediate<PushValue>),
    PushSlice(Immediate<WordValue>, Range<usize>),
    PushFeltList(Vec<Felt>),
    Locaddr(Immediate<u16>),
    Sdepth,
    Caller,
    Clk,
    MemLoad,
    MemLoadImm(Immediate<u32>),
    MemLoadWBe,
    MemLoadWBeImm(Immediate<u32>),
    MemLoadWLe,
    MemLoadWLeImm(Immediate<u32>),
    LocLoad(Immediate<u16>),
    LocLoadWBe(Immediate<u16>),
    LocLoadWLe(Immediate<u16>),
    MemStore,
    MemStoreImm(Immediate<u32>),
    MemStoreWBe,
    MemStoreWBeImm(Immediate<u32>),
    MemStoreWLe,
    MemStoreWLeImm(Immediate<u32>),
    LocStore(Immediate<u16>),
    LocStoreWBe(Immediate<u16>),
    LocStoreWLe(Immediate<u16>),
    MemStream,
    AdvPipe,
    AdvPush(Immediate<u8>),
    AdvLoadW,
    SysEvent(SystemEventNode),
    Hash,
    HMerge,
    HPerm,
    MTreeGet,
    MTreeSet,
    MTreeMerge,
    MTreeVerify,
    MTreeVerifyWithError(Immediate<Arc<str>>),
    CryptoStream,
    FriExt2Fold4,
    HornerBase,
    HornerExt,
    EvalCircuit,
    LogPrecompile,
    Exec(InvocationTarget),
    Call(InvocationTarget),
    SysCall(InvocationTarget),
    DynExec,
    DynCall,
    ProcRef(InvocationTarget),
    Debug(DebugOptions),
    DebugVar(DebugVarInfo),
    Emit,
    EmitImm(Immediate<Felt>),
    Trace(Immediate<u32>),
}

Expand description

Represents the set of primitive instructions in Miden Assembly syntax.

NOTE: For control flow instructions, see crate::ast::Op.

Variants§

§

Implementations§

Source §

impl Instruction

Source

pub const fn has_textual_representation(&self) -> bool

Returns true if this instruction has a textual representation in Miden Assembly.

Some instructions (like DebugVar) are compiler-internal and have no surface syntax. They should be skipped during pretty-printing.

Trait Implementations§

Source §

impl Clone for Instruction

Source §

fn clone(&self) -> Instruction

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 Instruction

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Display for Instruction

Source §

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

Formats the value using the given formatter. Read more

Source §

impl PartialEq for Instruction

Source §

fn eq(&self, other: &Instruction) -> 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 PrettyPrint for Instruction

Source §

fn render(&self) -> Document

The core of the PrettyPrint functionality. Read more

Source §

fn to_pretty_string(&self) -> String

Produce a String containing the results of pretty-printing this object. Read more

Source §

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

Pretty-print this object to the given core::fmt::Formatter. Read more

Source §

impl StructuralPartialEq for Instruction

Auto Trait Implementations§

§

impl RefUnwindSafe for Instruction

§

impl UnsafeUnpin for Instruction

§

impl UnwindSafe for Instruction

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> 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 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<D> OwoColorize for D

Source §

fn fg<C>(&self) -> FgColorDisplay<'_, C, Self>
where C: Color,

Set the foreground color generically Read more

Source §

fn bg<C>(&self) -> BgColorDisplay<'_, C, Self>
where C: Color,

Set the background color generically. Read more

Source §

fn black(&self) -> FgColorDisplay<'_, Black, Self>

Change the foreground color to black

Source §

fn on_black(&self) -> BgColorDisplay<'_, Black, Self>

Change the background color to black

Source §

fn red(&self) -> FgColorDisplay<'_, Red, Self>

Change the foreground color to red

Source §

fn on_red(&self) -> BgColorDisplay<'_, Red, Self>

Change the background color to red

Source §

fn green(&self) -> FgColorDisplay<'_, Green, Self>

Change the foreground color to green

Source §

fn on_green(&self) -> BgColorDisplay<'_, Green, Self>

Change the background color to green

Source §

fn yellow(&self) -> FgColorDisplay<'_, Yellow, Self>

Change the foreground color to yellow

Source §

fn on_yellow(&self) -> BgColorDisplay<'_, Yellow, Self>

Change the background color to yellow

Source §

fn blue(&self) -> FgColorDisplay<'_, Blue, Self>

Change the foreground color to blue

Source §

fn on_blue(&self) -> BgColorDisplay<'_, Blue, Self>

Change the background color to blue

Source §

fn magenta(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to magenta

Source §

fn on_magenta(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to magenta

Source §

fn purple(&self) -> FgColorDisplay<'_, Magenta, Self>

Change the foreground color to purple

Source §

fn on_purple(&self) -> BgColorDisplay<'_, Magenta, Self>

Change the background color to purple

Source §

fn cyan(&self) -> FgColorDisplay<'_, Cyan, Self>

Change the foreground color to cyan

Source §

fn on_cyan(&self) -> BgColorDisplay<'_, Cyan, Self>

Change the background color to cyan

Source §

fn white(&self) -> FgColorDisplay<'_, White, Self>

Change the foreground color to white

Source §

fn on_white(&self) -> BgColorDisplay<'_, White, Self>

Change the background color to white

Source §

fn default_color(&self) -> FgColorDisplay<'_, Default, Self>

Change the foreground color to the terminal default

Source §

fn on_default_color(&self) -> BgColorDisplay<'_, Default, Self>

Change the background color to the terminal default

Source §

fn bright_black(&self) -> FgColorDisplay<'_, BrightBlack, Self>

Change the foreground color to bright black

Source §

fn on_bright_black(&self) -> BgColorDisplay<'_, BrightBlack, Self>

Change the background color to bright black

Source §

fn bright_red(&self) -> FgColorDisplay<'_, BrightRed, Self>

Change the foreground color to bright red

Source §

fn on_bright_red(&self) -> BgColorDisplay<'_, BrightRed, Self>

Change the background color to bright red

Source §

fn bright_green(&self) -> FgColorDisplay<'_, BrightGreen, Self>

Change the foreground color to bright green

Source §

fn on_bright_green(&self) -> BgColorDisplay<'_, BrightGreen, Self>

Change the background color to bright green

Source §

fn bright_yellow(&self) -> FgColorDisplay<'_, BrightYellow, Self>

Change the foreground color to bright yellow

Source §

fn on_bright_yellow(&self) -> BgColorDisplay<'_, BrightYellow, Self>

Change the background color to bright yellow

Source §

fn bright_blue(&self) -> FgColorDisplay<'_, BrightBlue, Self>

Change the foreground color to bright blue

Source §

fn on_bright_blue(&self) -> BgColorDisplay<'_, BrightBlue, Self>

Change the background color to bright blue

Source §

fn bright_magenta(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright magenta

Source §

fn on_bright_magenta(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright magenta

Source §

fn bright_purple(&self) -> FgColorDisplay<'_, BrightMagenta, Self>

Change the foreground color to bright purple

Source §

fn on_bright_purple(&self) -> BgColorDisplay<'_, BrightMagenta, Self>

Change the background color to bright purple

Source §

fn bright_cyan(&self) -> FgColorDisplay<'_, BrightCyan, Self>

Change the foreground color to bright cyan

Source §

fn on_bright_cyan(&self) -> BgColorDisplay<'_, BrightCyan, Self>

Change the background color to bright cyan

Source §

fn bright_white(&self) -> FgColorDisplay<'_, BrightWhite, Self>

Change the foreground color to bright white

Source §

fn on_bright_white(&self) -> BgColorDisplay<'_, BrightWhite, Self>

Change the background color to bright white

Source §

fn bold(&self) -> BoldDisplay<'_, Self>

Make the text bold

Source §

fn dimmed(&self) -> DimDisplay<'_, Self>

Make the text dim

Source §

fn italic(&self) -> ItalicDisplay<'_, Self>

Make the text italicized

Source §

fn underline(&self) -> UnderlineDisplay<'_, Self>

Make the text underlined

Source §

fn blink(&self) -> BlinkDisplay<'_, Self>

Make the text blink

Source §

fn blink_fast(&self) -> BlinkFastDisplay<'_, Self>

Make the text blink (but fast!)

Source §

fn reversed(&self) -> ReversedDisplay<'_, Self>

Swap the foreground and background colors

Source §

fn hidden(&self) -> HiddenDisplay<'_, Self>

Hide the text

Source §

fn strikethrough(&self) -> StrikeThroughDisplay<'_, Self>

Cross out the text

Source §

fn color<Color>(&self, color: Color) -> FgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the foreground color at runtime. Only use if you do not know which color will be used at compile-time. If the color is constant, use either OwoColorize::fg or a color-specific method, such as OwoColorize::green, Read more

Source §

fn on_color<Color>(&self, color: Color) -> BgDynColorDisplay<'_, Color, Self>
where Color: DynColor,

Set the background color at runtime. Only use if you do not know what color to use at compile-time. If the color is constant, use either OwoColorize::bg or a color-specific method, such as OwoColorize::on_yellow, Read more

Source §