#[repr(u8)]pub enum Op {
Show 58 variants
LoadNil = 0,
LoadB = 1,
LoadN = 2,
LoadK = 3,
Move = 4,
GetGlobal = 5,
SetGlobal = 6,
Add = 7,
Sub = 8,
Mul = 9,
Div = 10,
IDiv = 11,
Mod = 12,
Pow = 13,
AddK = 14,
SubK = 15,
MulK = 16,
DivK = 17,
IDivK = 18,
ModK = 19,
PowK = 20,
Unm = 21,
Not = 22,
Len = 23,
Concat = 24,
Eq = 25,
Lt = 26,
Le = 27,
EqK = 28,
LtK = 29,
LeK = 30,
GtK = 31,
GeK = 32,
Jmp = 33,
JmpIf = 34,
JmpIfNot = 35,
ForPrep = 36,
ForLoop = 37,
GetUpval = 38,
SetUpval = 39,
Closure = 40,
Close = 41,
Call = 42,
Interp = 43,
TailCall = 44,
Vararg = 45,
NewTable = 46,
GetTable = 47,
GetField = 48,
SetTable = 49,
SetField = 50,
SelfOp = 51,
SetList = 52,
Data = 53,
TForCall = 54,
TForLoop = 55,
Return = 56,
DupTable = 57,
}Expand description
Every opcode. The comment on each one gives its operands, R(x) is
register x and K(x) is constant x.
Variants§
LoadNil = 0
R(A) := nil
LoadB = 1
R(A) := (B != 0); if C != 0 then pc++
LoadN = 2
R(A) := sBx (small integral numbers)
LoadK = 3
R(A) := K(Bx)
Move = 4
R(A) := R(B)
GetGlobal = 5
R(A) := globals[K(Bx)]
SetGlobal = 6
globals[K(Bx)] := R(A)
Add = 7
R(A) := R(B) + R(C)
Sub = 8
Mul = 9
Div = 10
IDiv = 11
Mod = 12
Pow = 13
AddK = 14
R(A) := R(B) + K(C)
SubK = 15
MulK = 16
DivK = 17
IDivK = 18
ModK = 19
PowK = 20
Unm = 21
R(A) := -R(B)
Not = 22
R(A) := not R(B)
Len = 23
R(A) := #R(B)
Concat = 24
R(A) := R(B) .. R(C)
Eq = 25
if (R(B) == R(C)) != (A != 0) then pc++ (the next instruction is a JMP)
Lt = 26
if (R(B) < R(C)) != (A != 0) then pc++
Le = 27
if (R(B) <= R(C)) != (A != 0) then pc++
EqK = 28
if (R(B) == K(C)) != (A != 0) then pc++ (same for the ones below,
constant on the right. a > b means b < a for errors)
LtK = 29
LeK = 30
GtK = 31
GeK = 32
Jmp = 33
pc += sAx (24-bit signed offset, relative to the next instruction)
JmpIf = 34
if R(A) is truthy then pc += sBx
JmpIfNot = 35
if R(A) is falsy then pc += sBx
ForPrep = 36
Numeric for setup. R(A) index, R(A+1) limit, R(A+2) step (all
checked to be numbers), R(A+3) the visible loop variable. Runs zero
times: pc += sBx. Otherwise R(A+3) := R(A).
ForLoop = 37
R(A) += R(A+2), and if it’s still in range, R(A+3) := R(A) and pc += sBx.
GetUpval = 38
R(A) := upvalues[B]
SetUpval = 39
upvalues[B] := R(A)
Closure = 40
R(A) := closure(protos[Bx]), capturing upvalues per the child’s
upvalues descriptors.
Close = 41
Closes every open upvalue pointing at R(A) or above.
Call = 42
R(A), ..., R(A+C-2) := R(A)(R(A+1), ..., R(A+B-1)). B = 0: arguments
go up to top. C = 0: keep every result and set top past the last
one.
Interp = 43
R(A) := tostring(R(B)) .. ... .. tostring(R(B+C-1)), for interpolated
strings (__tostring applies).
TailCall = 44
return R(A)(R(A+1), ..., R(A+B-1)). A Lua callee replaces the current
frame (so tail recursion doesn’t use stack), anything else gets called
like CALL A B 0 and the RETURN A 0 1 that always follows returns its
results.
Vararg = 45
R(A), ..., R(A+B-2) := .... B = 0: copy all the varargs and set
top.
NewTable = 46
R(A) := {} with room for B array and C hash entries (just hints).
GetTable = 47
R(A) := R(B)[R(C)]
GetField = 48
R(A) := R(B)[K(C)] (constant string key)
SetTable = 49
R(A)[R(B)] := R(C)
SetField = 50
R(A)[K(B)] := R(C) (constant string key)
SelfOp = 51
R(A+1) := R(B); R(A) := R(B)[K(C)] (method lookup for obj:m())
SetList = 52
R(A)[n + i] := R(A + i) for i in 1..=B (B = 0: up to top),
where n is the start offset in the DATA word after it.
Data = 53
Never executed, it’s an operand word for the instruction before it.
TForCall = 54
Generic-for step: R(A+3), ..., R(A+2+C) := R(A)(R(A+1), R(A+2)). If
R(A) is a table it gets iterated directly (Luau’s generalized
iteration, like next).
TForLoop = 55
if R(A+3) ~= nil then R(A+2) := R(A+3); pc += sBx
Return = 56
return R(A), ..., R(A+B-1), or if C != 0 return R(A) up to top.
DupTable = 57
R(A) := {} shaped by templates[Bx]. Room for its array and hash
sizes with its keys already in there (as nil), so a constructor’s
SETFIELDs fill existing slots through their inline caches.
Implementations§
Trait Implementations§
impl Copy for Op
impl Eq for Op
impl StructuralPartialEq for Op
Auto Trait Implementations§
impl Forget for Op
impl Freeze for Op
impl Move for Op
impl RefUnwindSafe for Op
impl Send for Op
impl Sync for Op
impl Unpin for Op
impl UnsafeUnpin for Op
impl UnwindSafe for Op
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);