Skip to main content

Chunk

Struct Chunk 

Source
pub struct Chunk { /* private fields */ }
Expand description

An assembled sequence of instructions with its constant pool.

Cloning a chunk is a deep copy of both vectors; it is cheap relative to execution and lets a compiled program be run many times. A chunk carries no interpreter state — that lives in the Vm — so the same chunk can be executed concurrently by separate VMs.

Implementations§

Source§

impl Chunk

Source

pub fn new() -> Self

Create an empty chunk with no instructions, no constants, and a zero-width register file.

§Examples
use bvm_lang::Chunk;

let chunk = Chunk::new();
assert!(chunk.is_empty());
assert_eq!(chunk.registers(), 0);
Source

pub fn emit(&mut self, op: Op) -> Addr

Append an instruction and return its address.

The returned Addr is where the instruction sits in the code array — the same value a branch uses as its target, and the argument patch takes to rewrite this slot later. Returning an Addr lets an emitted address feed straight back into a Jump/patch without a cast. Emitting widens the register file to include every register the instruction names.

§Examples
use bvm_lang::{Chunk, Op};

let mut chunk = Chunk::new();
let first = chunk.emit(Op::LoadInt { dst: 0, val: 41 });
assert_eq!(first, 0);
// Naming register 0 sized the file to one slot.
assert_eq!(chunk.registers(), 1);
Source

pub fn constant(&mut self, value: Value) -> Option<u16>

Add value to the constant pool and return its index for LoadConst.

Constants are not deduplicated; adding the same value twice yields two slots. This keeps the builder allocation-light and predictable — a compiler that wants interning can layer it on top.

§Errors

Returns None if the pool already holds u16::MAX + 1 constants, the most a Const index can address. A single function body reaching 65 536 distinct constants is pathological, so callers typically treat this as unreachable rather than a runtime path.

§Examples
use bvm_lang::{Chunk, Op, Value};

let mut chunk = Chunk::new();
let k = chunk.constant(Value::float(3.5)).expect("pool has room");
chunk.emit(Op::LoadConst { dst: 0, index: k });
Source

pub fn patch(&mut self, addr: Addr, op: Op) -> bool

Overwrite the instruction at addr, typically to fill in a branch target that was not known when the instruction was first emitted.

Returns true if addr was a valid slot and the rewrite happened, and false if it was out of range. Rewriting can change which registers the chunk touches, so the register file is re-derived from scratch to stay exact.

§Examples
use bvm_lang::{Chunk, Op};

let mut chunk = Chunk::new();
// Emit a forward branch whose target is not yet known.
let jump = chunk.emit(Op::Jump { target: 0 });
chunk.emit(Op::LoadInt { dst: 0, val: 1 }); // skipped by the jump
let landing = chunk.emit(Op::Halt);         // where the jump should land
// Now patch the branch to skip the load. `landing` is already an `Addr`.
assert!(chunk.patch(jump, Op::Jump { target: landing }));
Source

pub fn code(&self) -> &[Op]

The chunk’s instructions, in address order.

Source

pub fn constants(&self) -> &[Value]

The chunk’s constant pool, indexed by LoadConst.

Source

pub fn registers(&self) -> u16

The number of registers the chunk uses — one more than the highest register index any instruction names, or zero for a chunk that names none.

Source

pub fn len(&self) -> usize

The number of instructions in the chunk.

Source

pub fn is_empty(&self) -> bool

Whether the chunk contains no instructions.

Trait Implementations§

Source§

impl Clone for Chunk

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 Debug for Chunk

Source§

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

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

impl Default for Chunk

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for Chunk

Available on crate feature serde only.
Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for Chunk

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 Serialize for Chunk

Available on crate feature serde only.
Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for Chunk

Auto Trait Implementations§

§

impl Forget for Chunk

§

impl Freeze for Chunk

§

impl Move for Chunk

§

impl RefUnwindSafe for Chunk

§

impl Send for Chunk

§

impl Sync for Chunk

§

impl Unpin for Chunk

§

impl UnsafeUnpin for Chunk

§

impl UnwindSafe for Chunk

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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> 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.