Struct Instruction 

#[repr(transparent)]
pub struct Instruction(pub u32);

A single Lua bytecode instruction (unsigned 32-bit word).

C: typedef unsigned int Instruction; (see llimits.h)

Tuple Fields

0: u32

Implementations

impl Instruction

pub const fn get_arg(self, pos: u32, size: u32) -> u32

Extract a bit-field of size bits at position pos.

C: getarg(i, pos, size) — cast_int(((i)>>(pos)) & MASK1(size,0))

pub fn set_arg(&mut self, v: u32, pos: u32, size: u32)

Set a bit-field of size bits at position pos to v.

C: setarg(i, v, pos, size)

pub fn opcode(self) -> Option<OpCode>

Extract the opcode.

C: GET_OPCODE(i) — cast(OpCode, ((i)>>POS_OP) & MASK1(SIZE_OP,0))

pub fn set_opcode(&mut self, op: OpCode)

Replace the opcode field.

C: SET_OPCODE(i, o)

pub const fn arg_a(self) -> u32

C: GETARG_A(i)

pub fn set_arg_a(&mut self, v: u32)

C: SETARG_A(i, v)

pub const fn arg_k(self) -> u32

C: GETARG_k(i) — returns 0 or 1.

pub const fn test_k(self) -> bool

C: TESTARG_k(i) — boolean form of GETARG_k.

pub fn set_arg_k(&mut self, v: u32)

C: SETARG_k(i, v)

pub const fn arg_b(self) -> u32

C: GETARG_B(i) — debug-asserts iABC mode in C; here we trust the caller.

pub const fn arg_s_b(self) -> i32

C: GETARG_sB(i) — signed B (subtracts OFFSET_S_C).

pub fn set_arg_b(&mut self, v: u32)

C: SETARG_B(i, v)

pub const fn arg_c(self) -> u32

C: GETARG_C(i)

pub const fn arg_s_c(self) -> i32

C: GETARG_sC(i) — signed C (subtracts OFFSET_S_C).

pub fn set_arg_c(&mut self, v: u32)

C: SETARG_C(i, v)

pub const fn arg_bx(self) -> u32

C: GETARG_Bx(i) — unsigned Bx.

pub fn set_arg_bx(&mut self, v: u32)

C: SETARG_Bx(i, v)

pub const fn arg_s_bx(self) -> i32

C: GETARG_sBx(i) — signed Bx (subtracts OFFSET_S_BX).

pub fn set_arg_s_bx(&mut self, b: i32)

C: SETARG_sBx(i, b) — stores b + OFFSET_S_BX in the Bx field.

pub const fn arg_ax(self) -> u32

C: GETARG_Ax(i)

pub fn set_arg_ax(&mut self, v: u32)

C: SETARG_Ax(i, v)

pub const fn arg_s_j(self) -> i32

C: GETARG_sJ(i) — signed J (subtracts OFFSET_S_J).

pub fn set_arg_s_j(&mut self, j: i32)

C: SETARG_sJ(i, j) — stores j + OFFSET_S_J in the sJ field.

pub fn abck(op: OpCode, a: u32, b: u32, c: u32, k: u32) -> Self

Build an iABC instruction.

C: CREATE_ABCk(o, a, b, c, k)

pub fn abx(op: OpCode, a: u32, bc: u32) -> Self

Build an iABx instruction.

C: CREATE_ABx(o, a, bc)

pub fn ax(op: OpCode, a: u32) -> Self

Build an iAx instruction.

C: CREATE_Ax(o, a)

pub fn sj(op: OpCode, j: u32, k: u32) -> Self

Build an isJ instruction.

C: CREATE_sJ(o, j, k)

pub fn is_out_top(self) -> bool

True if this instruction sets L->top for the next instruction.

C: isOT(i) — (testOTMode(GET_OPCODE(i)) && GETARG_C(i) == 0) || GET_OPCODE(i) == OP_TAILCALL

pub fn is_in_top(self) -> bool

True if this instruction uses L->top from the previous instruction.

C: isIT(i) — testITMode(GET_OPCODE(i)) && GETARG_B(i) == 0

pub fn op_mode(self) -> Option<OpMode>

Return the OpMode for this instruction.

C: getOpMode(GET_OPCODE(i))

Trait Implementations

impl Clone for Instruction

fn clone(&self) -> Instruction

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Instruction

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

Formats the value using the given formatter.

impl Default for Instruction

fn default() -> Instruction

Returns the “default value” for a type.

impl PartialEq for Instruction

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl Copy for Instruction

impl Eq for Instruction

impl StructuralPartialEq for Instruction