pub enum Instruction {
Show 60 variants
Move(Reg, Reg),
MoveConst(Reg, ConstPos),
MoveImmF(Reg, HFloat),
MoveRange(Reg, Reg, TypeSize),
Call(Reg, u8, TypeSize),
CallCls(Reg, u8, TypeSize),
CallExtFun(Reg, u8, TypeSize),
Closure(Reg, Reg),
Close(Reg),
GetUpValue(Reg, Reg, TypeSize),
SetUpValue(Reg, Reg, TypeSize),
GetGlobal(Reg, GlobalPos, TypeSize),
SetGlobal(GlobalPos, Reg, TypeSize),
GetState(Reg, TypeSize),
SetState(Reg, TypeSize),
PushStatePos(StateOffset),
PopStatePos(StateOffset),
Return0,
Return(Reg, TypeSize),
Delay(Reg, Reg, Reg),
Mem(Reg, Reg),
Jmp(Offset),
JmpIfNeg(Reg, Offset),
AddF(Reg, Reg, Reg),
SubF(Reg, Reg, Reg),
MulF(Reg, Reg, Reg),
DivF(Reg, Reg, Reg),
ModF(Reg, Reg, Reg),
NegF(Reg, Reg),
AbsF(Reg, Reg),
SqrtF(Reg, Reg),
SinF(Reg, Reg),
CosF(Reg, Reg),
PowF(Reg, Reg, Reg),
LogF(Reg, Reg),
AddI(Reg, Reg, Reg),
SubI(Reg, Reg, Reg),
MulI(Reg, Reg, Reg),
DivI(Reg, Reg, Reg),
ModI(Reg, Reg, Reg),
NegI(Reg, Reg),
AbsI(Reg, Reg),
PowI(Reg, Reg, Reg),
LogI(Reg, Reg, Reg),
Not(Reg, Reg),
Eq(Reg, Reg, Reg),
Ne(Reg, Reg, Reg),
Gt(Reg, Reg, Reg),
Ge(Reg, Reg, Reg),
Lt(Reg, Reg, Reg),
Le(Reg, Reg, Reg),
And(Reg, Reg, Reg),
Or(Reg, Reg, Reg),
CastFtoI(Reg, Reg),
CastItoF(Reg, Reg),
CastItoB(Reg, Reg),
AllocArray(Reg, Reg, TypeSize),
GetArrayElem(Reg, Reg, Reg),
SetArrayElem(Reg, Reg, Reg),
Dummy,
}
Expand description
Instructions for bytecode. Currently, each instructon has the 64 bit size(Tag, up to 3 bytes arguments.)
Variants§
Move(Reg, Reg)
Move Single Value, Destination, Source
MoveConst(Reg, ConstPos)
Load Single Value from Constants. Destination, Source
MoveImmF(Reg, HFloat)
Load Immediate float from half precision. Destination, Value
MoveRange(Reg, Reg, TypeSize)
Call(Reg, u8, TypeSize)
Call to internal function Function Address,Nargs,Word Size of Return Value
CallCls(Reg, u8, TypeSize)
CallExtFun(Reg, u8, TypeSize)
Call external rust functions or closure,
Currently, The execution branches into the invocation of a raw function item(function pointer), or Rust Closure depending on the information on the VM.
Previously there was another operation CallExtCls
for Rust Closure Invocation separately but keeping distinction between raw function pointer and closure at the type checking and program generation stage, makes compiler’s design complex thus it was removed.
The distincion may also be resolved statically at linking time.
Function Address,Nargs,Nret
Closure(Reg, Reg)
Create new closure. Destination, index of inner function prototype in global function table.
Close(Reg)
register of the closure to be closed. other local closures will be released with this instruction.
GetUpValue(Reg, Reg, TypeSize)
destination,source, size
SetUpValue(Reg, Reg, TypeSize)
GetGlobal(Reg, GlobalPos, TypeSize)
destination,source
SetGlobal(GlobalPos, Reg, TypeSize)
GetState(Reg, TypeSize)
Call internal state over time, destination,source
SetState(Reg, TypeSize)
PushStatePos(StateOffset)
PopStatePos(StateOffset)
Return0
Return from current function without return value.
Return(Reg, TypeSize)
value start position, Nrets
Delay(Reg, Reg, Reg)
Mem(Reg, Reg)
Jmp(Offset)
jump to instruction over the offset.
JmpIfNeg(Reg, Offset)
jump to instruction over the offset if the value in the first argument was negative.
AddF(Reg, Reg, Reg)
Primitive Operations. Destination, Src1, Src2
SubF(Reg, Reg, Reg)
MulF(Reg, Reg, Reg)
DivF(Reg, Reg, Reg)
ModF(Reg, Reg, Reg)
NegF(Reg, Reg)
AbsF(Reg, Reg)
SqrtF(Reg, Reg)
SinF(Reg, Reg)
CosF(Reg, Reg)
PowF(Reg, Reg, Reg)
LogF(Reg, Reg)
AddI(Reg, Reg, Reg)
SubI(Reg, Reg, Reg)
MulI(Reg, Reg, Reg)
DivI(Reg, Reg, Reg)
ModI(Reg, Reg, Reg)
NegI(Reg, Reg)
AbsI(Reg, Reg)
PowI(Reg, Reg, Reg)
LogI(Reg, Reg, Reg)
Not(Reg, Reg)
Eq(Reg, Reg, Reg)
Ne(Reg, Reg, Reg)
Gt(Reg, Reg, Reg)
Ge(Reg, Reg, Reg)
Lt(Reg, Reg, Reg)
Le(Reg, Reg, Reg)
And(Reg, Reg, Reg)
Or(Reg, Reg, Reg)
CastFtoI(Reg, Reg)
CastItoF(Reg, Reg)
CastItoB(Reg, Reg)
AllocArray(Reg, Reg, TypeSize)
Allocate new array in the heap. Destination, size of array, type size of each element
GetArrayElem(Reg, Reg, Reg)
Get array element: destination, array, index
SetArrayElem(Reg, Reg, Reg)
Set array element. Because the array is immutable, this instruction is mostly used for initialization. array, index, value.
Dummy
Dummy instruction for testing
Trait Implementations§
Source§impl Clone for Instruction
impl Clone for Instruction
Source§fn clone(&self) -> Instruction
fn clone(&self) -> Instruction
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for Instruction
impl Debug for Instruction
Source§impl Display for Instruction
impl Display for Instruction
Source§impl PartialEq for Instruction
impl PartialEq for Instruction
impl Copy for Instruction
impl StructuralPartialEq for Instruction
Auto Trait Implementations§
impl Freeze for Instruction
impl RefUnwindSafe for Instruction
impl Send for Instruction
impl Sync for Instruction
impl Unpin for Instruction
impl UnwindSafe for Instruction
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> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§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>
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);