Struct Module 

pub struct Module { /* private fields */ }

A compiled bytecode module.

Instructions are decoded lazily via decode_step. Cold data (strings, symbols, types) is accessed through view methods.

Implementations

impl Module

pub fn from_aligned(vec: AlignedVec) -> Result<Self, ModuleError>

Load a module from an aligned vector (compiler output).

This is the primary constructor for bytecode produced by the compiler.

pub fn from_static(bytes: &'static [u8]) -> Result<Self, ModuleError>

Load a module from static bytes (zero-copy).

Use with include_query_aligned! to embed aligned bytecode:

use plotnik_lib::include_query_aligned;

let module = Module::from_static(include_query_aligned!("query.ptk.bin"))?;

Panics

Panics if bytes are not 64-byte aligned.

pub fn from_path(path: impl AsRef<Path>) -> Result<Self, ModuleError>

Load a module from a file path.

Reads the file into 64-byte aligned storage.

pub fn load(bytes: &[u8]) -> Result<Self, ModuleError>

Load a module from arbitrary bytes (copies into aligned storage).

Use this for bytes from unknown sources (network, etc.). Always copies.

pub fn from_bytes(bytes: Vec<u8>) -> Result<Self, ModuleError>

👎Deprecated since 0.1.0: use Module::from_aligned for AlignedVec or Module::load for copying

Load a module from owned bytes (copies into aligned storage).

pub fn header(&self) -> &Header

Get the parsed header.

pub fn offsets(&self) -> &SectionOffsets

Get the computed section offsets.

pub fn bytes(&self) -> &[u8]

Get the raw bytes.

pub fn decode_step(&self, step: u16) -> Instruction<'_>

Decode an instruction at the given step index.

pub fn strings(&self) -> StringsView<'_>

Get a view into the string table.

pub fn node_types(&self) -> SymbolsView<'_, NodeSymbol>

Get a view into the node type symbols.

pub fn node_fields(&self) -> SymbolsView<'_, FieldSymbol>

Get a view into the node field symbols.

pub fn trivia(&self) -> TriviaView<'_>

Get a view into the trivia entries.

pub fn regexes(&self) -> RegexView<'_>

Get a view into the regex table.

pub fn types(&self) -> TypesView<'_>

Get a view into the type metadata.

pub fn entrypoints(&self) -> EntrypointsView<'_>

Get a view into the entrypoints.

Trait Implementations

impl Debug for Module

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

Formats the value using the given formatter.