Skip to main content

Op

Enum Op 

Source
#[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§

Source§

impl Op

Source

pub const ALL: &'static [Op]

Source

pub fn from_u8(byte: u8) -> Option<Op>

Decodes an opcode byte. It’s a match on each opcode’s own value so the optimiser sees the identity mapping (a lookup table would cost a load per instruction in the VM).

Source

pub fn mnemonic(self) -> &'static str

Source§

impl Op

Source

pub fn arith_rr(op: ArithOp) -> Op

The register-register opcode for an arithmetic operator.

Source

pub fn arith_rk(op: ArithOp) -> Op

The register-constant opcode for an arithmetic operator.

Source

pub fn as_arith(self) -> Option<ArithOp>

Inverse of Op::arith_rr / Op::arith_rk.

Trait Implementations§

Source§

impl Clone for Op

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 Op

Source§

impl Debug for Op

Source§

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

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

impl Eq for Op

Source§

impl Hash for Op

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 Op

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 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> 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> Paint for T
where T: ?Sized,

Source§

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 primary(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Primary].

§Example
println!("{}", value.primary());
Source§

fn fixed(&self, color: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Fixed].

§Example
println!("{}", value.fixed(color));
Source§

fn rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the fg() set to [Color :: Rgb].

§Example
println!("{}", value.rgb(r, g, b));
Source§

fn black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Black].

§Example
println!("{}", value.black());
Source§

fn red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Red].

§Example
println!("{}", value.red());
Source§

fn green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Green].

§Example
println!("{}", value.green());
Source§

fn yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Yellow].

§Example
println!("{}", value.yellow());
Source§

fn blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Blue].

§Example
println!("{}", value.blue());
Source§

fn magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Magenta].

§Example
println!("{}", value.magenta());
Source§

fn cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: Cyan].

§Example
println!("{}", value.cyan());
Source§

fn white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: White].

§Example
println!("{}", value.white());
Source§

fn bright_black(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlack].

§Example
println!("{}", value.bright_black());
Source§

fn bright_red(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightRed].

§Example
println!("{}", value.bright_red());
Source§

fn bright_green(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightGreen].

§Example
println!("{}", value.bright_green());
Source§

fn bright_yellow(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightYellow].

§Example
println!("{}", value.bright_yellow());
Source§

fn bright_blue(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightBlue].

§Example
println!("{}", value.bright_blue());
Source§

fn bright_magenta(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.bright_magenta());
Source§

fn bright_cyan(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightCyan].

§Example
println!("{}", value.bright_cyan());
Source§

fn bright_white(&self) -> Painted<&T>

Returns self with the fg() set to [Color :: BrightWhite].

§Example
println!("{}", value.bright_white());
Source§

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>

Returns self with the bg() set to [Color :: Primary].

§Example
println!("{}", value.on_primary());
Source§

fn on_fixed(&self, color: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Fixed].

§Example
println!("{}", value.on_fixed(color));
Source§

fn on_rgb(&self, r: u8, g: u8, b: u8) -> Painted<&T>

Returns self with the bg() set to [Color :: Rgb].

§Example
println!("{}", value.on_rgb(r, g, b));
Source§

fn on_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Black].

§Example
println!("{}", value.on_black());
Source§

fn on_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Red].

§Example
println!("{}", value.on_red());
Source§

fn on_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Green].

§Example
println!("{}", value.on_green());
Source§

fn on_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Yellow].

§Example
println!("{}", value.on_yellow());
Source§

fn on_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Blue].

§Example
println!("{}", value.on_blue());
Source§

fn on_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Magenta].

§Example
println!("{}", value.on_magenta());
Source§

fn on_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: Cyan].

§Example
println!("{}", value.on_cyan());
Source§

fn on_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: White].

§Example
println!("{}", value.on_white());
Source§

fn on_bright_black(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlack].

§Example
println!("{}", value.on_bright_black());
Source§

fn on_bright_red(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightRed].

§Example
println!("{}", value.on_bright_red());
Source§

fn on_bright_green(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightGreen].

§Example
println!("{}", value.on_bright_green());
Source§

fn on_bright_yellow(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightYellow].

§Example
println!("{}", value.on_bright_yellow());
Source§

fn on_bright_blue(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightBlue].

§Example
println!("{}", value.on_bright_blue());
Source§

fn on_bright_magenta(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightMagenta].

§Example
println!("{}", value.on_bright_magenta());
Source§

fn on_bright_cyan(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightCyan].

§Example
println!("{}", value.on_bright_cyan());
Source§

fn on_bright_white(&self) -> Painted<&T>

Returns self with the bg() set to [Color :: BrightWhite].

§Example
println!("{}", value.on_bright_white());
Source§

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 bold(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Bold].

§Example
println!("{}", value.bold());
Source§

fn dim(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Dim].

§Example
println!("{}", value.dim());
Source§

fn italic(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Italic].

§Example
println!("{}", value.italic());
Source§

fn underline(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Underline].

§Example
println!("{}", value.underline());

Returns self with the attr() set to [Attribute :: Blink].

§Example
println!("{}", value.blink());

Returns self with the attr() set to [Attribute :: RapidBlink].

§Example
println!("{}", value.rapid_blink());
Source§

fn invert(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Invert].

§Example
println!("{}", value.invert());
Source§

fn conceal(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Conceal].

§Example
println!("{}", value.conceal());
Source§

fn strike(&self) -> Painted<&T>

Returns self with the attr() set to [Attribute :: Strike].

§Example
println!("{}", value.strike());
Source§

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 mask(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Mask].

§Example
println!("{}", value.mask());
Source§

fn wrap(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Wrap].

§Example
println!("{}", value.wrap());
Source§

fn linger(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Linger].

§Example
println!("{}", value.linger());
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.

Returns self with the quirk() set to [Quirk :: Clear].

§Example
println!("{}", value.clear());
Source§

fn resetting(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Resetting].

§Example
println!("{}", value.resetting());
Source§

fn bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: Bright].

§Example
println!("{}", value.bright());
Source§

fn on_bright(&self) -> Painted<&T>

Returns self with the quirk() set to [Quirk :: OnBright].

§Example
println!("{}", value.on_bright());
Source§

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);
Source§

fn new(self) -> Painted<Self>
where Self: Sized,

Create a new Painted with a default Style. Read more
Source§

fn paint<S>(&self, style: S) -> Painted<&Self>
where S: Into<Style>,

Apply a style wholesale to self. Any previous style is replaced. Read more
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.