Struct itsy::bytecode::Writer

pub struct Writer<T> where
    T: VMFunc<T>,  { /* fields omitted */ }

Bytecode buffer and writer. Extended from opcodes.rs with the individual opcodes that can be written.

Methods

impl<T> Writer<T> where
    T: VMFunc<T>, 

pub fn new() -> Self

Creates a new writer instance.

pub fn len(&self) -> u32

Returns the current length of the program.

pub fn position(&self) -> u32

Returns the current write position.

pub fn set_position(&mut self, new_position: u32)

Sets the current write position.

pub fn into_program(self) -> Program<T>

Converts the writer into the underlying buffer.

pub fn overwrite<F>(&mut self, position: u32, write_fn: F) -> u32 where
    F: FnMut(&mut Self) -> u32, 

Overwrites the program at given position and returns to the previous position afterwards.

impl<T> Writer<T> where
    T: VMFunc<T>, 

Bytecode writers. Generated from bytecode method signatures defined via the impl_vm! macro.

pub fn debug(&mut self, label: u32) -> u32

Does nothing. Used as label when debugging.

pub fn reserve(&mut self, num_items: u8) -> u32

Moves the stack pointer by given number of items (32bit words) to make room for local variables.

pub fn constr16(&mut self, const_id: u8) -> u32

Load 2 byte from constant pool onto stack.

pub fn constr16_16(&mut self, const_id: u16) -> u32

Load 2 byte from constant pool onto stack.

pub fn constr32(&mut self, const_id: u8) -> u32

Load 4 byte from constant pool onto stack.

pub fn constr32_16(&mut self, const_id: u16) -> u32

Load 4 byte from constant pool onto stack.

pub fn constr64(&mut self, const_id: u8) -> u32

Load 8 byte from constant pool onto stack.

pub fn constr64_16(&mut self, const_id: u16) -> u32

Load 8 byte from constant pool onto stack.

pub fn consto(&mut self, const_id: u8) -> u32

Load object from constant pool onto stack+heap.

pub fn consto_16(&mut self, const_id: u16) -> u32

Load object from constant pool onto stack+heap.

pub fn litu(&mut self, value: u8) -> u32

Push value onto stack.

pub fn lits(&mut self, value: i8) -> u32

Push value onto stack.

pub fn lit0(&mut self) -> u32

Push 0 onto stack.

pub fn lit1(&mut self) -> u32

Push 1 onto stack.

pub fn lit2(&mut self) -> u32

Push 2 onto stack.

pub fn litm1(&mut self) -> u32

Push -1 onto stack.

pub fn loadr32(&mut self, offset: i32) -> u32

Load stackvalue from offset (relative to the stackframe) and push onto the stack.

pub fn storer32(&mut self, offset: i32) -> u32

Pop stackvalue and store it at the given offset (relative to the stackframe).

pub fn loadr64(&mut self, offset: i32) -> u32

Load 64 bit stackvalue from offset (relative to the stackframe) and push onto the stack.

pub fn storer64(&mut self, offset: i32) -> u32

Pop 64 bit stackvalue and store it at the given offset (relative to the stackframe).

pub fn load_arg1(&mut self) -> u32

Load function argument 1 and push it onto the stack. Equivalent to load -4.

pub fn load_arg2(&mut self) -> u32

Load function argument 2 and push it onto the stack. Equivalent to load -5.

pub fn load_arg3(&mut self) -> u32

Load function argument 3 and push it onto the stack. Equivalent to load -6.

pub fn rustcall(&mut self, func: T) -> u32

Calls the given Rust function.

pub fn call(&mut self, addr: u32, num_args: u8) -> u32

Function call. Saves state and sets programm counter to given addr. Expects callee arguments on the stack and number of arguments (in 32 bit words) as num_args.

pub fn ret(&mut self, num_ret: u8) -> u32

Function return. Restores state, removes arguments left on stack by caller and leaves call result on the stack.

pub fn and(&mut self) -> u32

Pops 2 values from the stack and pushes their logical conjunction.

pub fn or(&mut self) -> u32

Pops 2 values from the stack and pushes their logical disjunction.

pub fn not(&mut self) -> u32

Pops a values from the stack and pushes its logical negation.

pub fn addi(&mut self) -> u32

Pops 2 values from the stack and pushes their sum.

pub fn subi(&mut self) -> u32

Pops 2 values from the stack and pushes their difference.

pub fn muli(&mut self) -> u32

Pops 2 values from the stack and pushes their product.

pub fn addf(&mut self) -> u32

Pops 2 values from the stack and pushes their sum.

pub fn subf(&mut self) -> u32

Pops 2 values from the stack and pushes their sum.

pub fn mulf(&mut self) -> u32

Pops 2 values from the stack and pushes their product.

pub fn addi64(&mut self) -> u32

Pops 2 values from the stack and pushes their sum.

pub fn subi64(&mut self) -> u32

Pops 2 values from the stack and pushes their difference.

pub fn muli64(&mut self) -> u32

Pops 2 values from the stack and pushes their product.

pub fn addf64(&mut self) -> u32

Pops 2 values from the stack and pushes their sum.

pub fn subf64(&mut self) -> u32

Pops 2 values from the stack and pushes their sum.

pub fn mulf64(&mut self) -> u32

Pops 2 values from the stack and pushes their product.

pub fn jmp(&mut self, addr: u32) -> u32

Jumps unconditionally to the given address.

pub fn j0(&mut self, addr: u32) -> u32

Pops one values and jumps to given address if it is 0.

pub fn jeqr32(&mut self, addr: u32) -> u32

Pops two values and jumps to given address it they equal.

pub fn jeqr64(&mut self, addr: u32) -> u32

Pops two values and jumps to given address it they equal.

pub fn jneqr32(&mut self, addr: u32) -> u32

Pops two values and jumps to given address it they are not equal.

pub fn jneqr64(&mut self, addr: u32) -> u32

Pops two values and jumps to given address it they are not equal.

pub fn jlts32(&mut self, addr: u32) -> u32

Pops two values and jumps to given address if the first value is less than the second.

pub fn jltu32(&mut self, addr: u32) -> u32

Pops two values and jumps to given address if the first value is less than the second.

pub fn jltf32(&mut self, addr: u32) -> u32

Pops two values and jumps to given address if the first value is less than the second.

pub fn jlts64(&mut self, addr: u32) -> u32

Pops two values and jumps to given address if the first value is less than the second.

pub fn jltu64(&mut self, addr: u32) -> u32

Pops two values and jumps to given address if the first value is less than the second.

pub fn jltf64(&mut self, addr: u32) -> u32

Pops two values and jumps to given address if the first value is less than the second.

pub fn jltes32(&mut self, addr: u32) -> u32

Pops two values and jumps to given address if the first value is less/equal the second.

pub fn jlteu32(&mut self, addr: u32) -> u32

Pops two values and jumps to given address if the first value is less/equal the second.

pub fn jltef32(&mut self, addr: u32) -> u32

Pops two values and jumps to given address if the first value is less/equal the second.

pub fn jltes64(&mut self, addr: u32) -> u32

Pops two values and jumps to given address if the first value is less/equal the second.

pub fn jlteu64(&mut self, addr: u32) -> u32

Pops two values and jumps to given address if the first value is less/equal the second.

pub fn jltef64(&mut self, addr: u32) -> u32

Pops two values and jumps to given address if the first value is less/equal the second.

pub fn ceqr32(&mut self) -> u32

Pops two values and pushes a 1 if the first value equals the second, otherwise a 0.

pub fn ceqr64(&mut self) -> u32

Pops two values and pushes a 1 if the first value equals the second, otherwise a 0.

pub fn cneqr32(&mut self) -> u32

Pops two values and pushes a 1 if the first value does not equal the second, otherwise a 0.

pub fn cneqr64(&mut self) -> u32

Pops two values and pushes a 1 if the first value does not equal the second, otherwise a 0.

pub fn clts32(&mut self) -> u32

Pops two values and pushes a 1 if the first value is lesser than the second, otherwise a 0.

pub fn cltu32(&mut self) -> u32

Pops two values and pushes a 1 if the first value is lesser than the second, otherwise a 0.

pub fn cltf32(&mut self) -> u32

Pops two values and pushes a 1 if the first value is lesser than the second, otherwise a 0.

pub fn clts64(&mut self) -> u32

Pops two values and pushes a 1 if the first value is lesser than the second, otherwise a 0.

pub fn cltu64(&mut self) -> u32

Pops two values and pushes a 1 if the first value is lesser than the second, otherwise a 0.

pub fn cltf64(&mut self) -> u32

Pops two values and pushes a 1 if the first value is lesser than the second, otherwise a 0.

pub fn cltes32(&mut self) -> u32

Pops two values and pushes a 1 if the first value is lesser or equal the second, otherwise a 0.

pub fn clteu32(&mut self) -> u32

Pops two values and pushes a 1 if the first value is lesser or equal the second, otherwise a 0.

pub fn cltef32(&mut self) -> u32

Pops two values and pushes a 1 if the first value is lesser or equal the second, otherwise a 0.

pub fn cltes64(&mut self) -> u32

Pops two values and pushes a 1 if the first value is lesser or equal the second, otherwise a 0.

pub fn clteu64(&mut self) -> u32

Pops two values and pushes a 1 if the first value is lesser or equal the second, otherwise a 0.

pub fn cltef64(&mut self) -> u32

Pops two values and pushes a 1 if the first value is lesser or equal the second, otherwise a 0.

pub fn inci(&mut self) -> u32

Increments the value at the top of the stack.

pub fn deci(&mut self) -> u32

Decrements the value at the top of the stack.

pub fn inci64(&mut self) -> u32

Increments the value at the top of the stack.

pub fn deci64(&mut self) -> u32

Decrements the value at the top of the stack.

pub fn preinci(&mut self, offset: i32) -> u32

Increments the stackvalue at given offset (relative to the stackframe) and pushes the result onto the stack.

pub fn predeci(&mut self, offset: i32) -> u32

Decrements the stackvalue at given offset (relative to the stackframe) and pushes the result onto the stack.

pub fn preinci64(&mut self, offset: i32) -> u32

Increments the stackvalue at given offset (relative to the stackframe) and pushes the result onto the stack.

pub fn predeci64(&mut self, offset: i32) -> u32

Decrements the stackvalue at given offset (relative to the stackframe) and pushes the result onto the stack.

pub fn postinci(&mut self, offset: i32) -> u32

Increments the stackvalue at given offset (relative to the stackframe) and pushes the previous value onto the stack.

pub fn postdeci(&mut self, offset: i32) -> u32

Decrements the stackvalue at given offset (relative to the stackframe) and pushes the previous value onto the stack.

pub fn postinci64(&mut self, offset: i32) -> u32

Increments the stackvalue at given offset (relative to the stackframe) and pushes the previous value onto the stack.

pub fn postdeci64(&mut self, offset: i32) -> u32

Decrements the stackvalue at given offset (relative to the stackframe) and pushes the previous value onto the stack.

pub fn yld(&mut self) -> u32

Yield program execution.

pub fn exit(&mut self) -> u32

Terminate program execution.

Trait Implementations

impl<T: Debug> Debug for Writer<T> where
    T: VMFunc<T>, 

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

Formats the value using the given formatter.

impl<T> Write for Writer<T> where
    T: VMFunc<T>, 

Implement Write trait for program instructions.

fn write(&mut self, buf: &[u8]) -> Result<usize>

Write a buffer into this writer, returning how many bytes were written.

fn write_all(&mut self, buf: &[u8]) -> Result<()>

Attempts to write an entire buffer into this writer.

fn flush(&mut self) -> Result<()>

Flush this output stream, ensuring that all intermediately buffered contents reach their destination.

fn write_vectored(&mut self, bufs: &[IoVec]) -> Result<usize, Error>

🔬 This is a nightly-only experimental API. (iovec)

Like write, except that it writes from a slice of buffers.

fn write_fmt(&mut self, fmt: Arguments) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Write.

impl<T> Seek for Writer<T> where
    T: VMFunc<T>, 

Implement Seek trait for program instructions.

fn seek(&mut self, pos: SeekFrom) -> Result<u64>

Seek to an offset, in bytes, in a stream.