vihaco_bytecode (crate)

`vihaco_bytecode`¶

vihaco_bytecode

class`BytecodeFile`¶source

vihaco_bytecode::BytecodeFile

Bases: Debug, Clone

Rust struct. A parsed bytecode file.

pub struct BytecodeFile<C>

source

method`context`¶source

vihaco_bytecode::BytecodeFile::context

pub fn context(&self) -> &C

Returns

&C

source

method`context_handle`¶source

vihaco_bytecode::BytecodeFile::context_handle

pub fn context_handle(&self) -> ContextHandle<C>

Returns

ContextHandle<C>

source

method`from_bytes`¶source

vihaco_bytecode::BytecodeFile::from_bytes

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

Parameters

Name	Type	Description
`bytes`	`Vec<u8>`

Returns

Result<Self>

Parse a bytecode file from bytes.

source

method`root`¶source

vihaco_bytecode::BytecodeFile::root

pub fn root(&self) -> BytecodeSectionView<'_, C>

Returns

BytecodeSectionView<'_, C>

The view of the root of the bytecode section tree.

source

class`BytecodeSectionView`¶source

vihaco_bytecode::BytecodeSectionView

Bases: Clone, Debug

Rust struct. A lightweight view into a parsed bytecode section.

pub struct BytecodeSectionView<'bc, C>

source

method`bytecode`¶source

vihaco_bytecode::BytecodeSectionView::bytecode

pub fn bytecode(&self) -> &'bc [u8]

Returns

&'bc [u8]

source

method`child`¶source

vihaco_bytecode::BytecodeSectionView::child

Signature

pub fn child(&self, local_name: &str) -> Option<BytecodeSectionView<'bc, C>>

Parameters

Name	Type	Description
`local_name`	`&str`

Returns

Option<BytecodeSectionView<'bc, C>>

source

method`children`¶source

vihaco_bytecode::BytecodeSectionView::children

pub fn children(&self) -> impl Iterator + '_

Returns

impl Iterator + '_

source

method`context_handle`¶source

vihaco_bytecode::BytecodeSectionView::context_handle

pub fn context_handle(&self) -> ContextHandle<C>

Returns

ContextHandle<C>

source

method`decode_header`¶source

vihaco_bytecode::BytecodeSectionView::decode_header

pub fn decode_header<H: BytecodeHeader>(&self) -> Result<H>

Returns

Result<H>

Decode the specified composite header from raw header bytes.

source

method`decode_instructions`¶source

vihaco_bytecode::BytecodeSectionView::decode_instructions

pub fn decode_instructions<I: Instruction>(&self) -> Result<Vec<I>>

Returns

Result<Vec<I>>

Decode this section’s bytecode body as an instruction stream.

source

method`display_path`¶source

vihaco_bytecode::BytecodeSectionView::display_path

pub fn display_path(&self) -> &'bc SectionPath

Returns

&'bc SectionPath

source

method`header_bytes`¶source

vihaco_bytecode::BytecodeSectionView::header_bytes

pub fn header_bytes(&self) -> &'bc [u8]

Returns

&'bc [u8]

source

method`local_name`¶source

vihaco_bytecode::BytecodeSectionView::local_name

pub fn local_name(&self) -> Option<&str>

Returns

Option<&str>

source

method`path`¶source

vihaco_bytecode::BytecodeSectionView::path

pub fn path(&self) -> &'bc SectionPath

Returns

&'bc SectionPath

source

class`ConstantId`¶source

vihaco_bytecode::ConstantId

Bases: Debug, Clone, Copy, StructuralPartialEq, PartialEq, Eq, PartialOrd, Ord, Hash, From<u32>, From<ConstantId>, FromBytes, WriteBytes, OpCode, Display

Rust struct.

pub struct ConstantId

Fields

Name	Type	Description
`0`	`u32`

source

class`ContextHandle`¶source

vihaco_bytecode::ContextHandle

Bases: Debug, Clone, Deref

Rust struct. The public handle for a global context.

pub struct ContextHandle<C>

To avoid needing explicit lifetimes permeating throughout machine definitions, we wrap the context in an Arc to drop it automatically.

source

method`get`¶source

vihaco_bytecode::ContextHandle::get

pub fn get(&self) -> &C

Returns

&C

source

method`new`¶source

vihaco_bytecode::ContextHandle::new

pub fn new(context: C) -> Self

Parameters

Name	Type	Description
`context`	`C`

Returns

Self

source

method`ptr_eq`¶source

vihaco_bytecode::ContextHandle::ptr_eq

pub fn ptr_eq(&self, other: &Self) -> bool

Parameters

Name	Type	Description
`other`	`&Self`

Returns

bool

source

class`NoContext`¶source

vihaco_bytecode::NoContext

Bases: Debug, Clone, Copy, Default, StructuralPartialEq, PartialEq, Eq, PartialOrd, Ord, Hash, SstGlobalContext

Rust struct. Marker context for SST files that do not carry global metadata.

pub struct NoContext

`NoContext` accepts an omitted or empty global section.

source

class`SectionPath`¶source

vihaco_bytecode::SectionPath

Bases: Clone, StructuralPartialEq, PartialEq, Eq, PartialOrd, Ord, Hash, Default, Display, Debug

Rust struct. The fully resolved path for a parsed section.

pub struct SectionPath

The root section has no components.

source

method`components`¶source

vihaco_bytecode::SectionPath::components

pub fn components(&self) -> &[String]

Returns

&[String]

source

method`is_root`¶source

vihaco_bytecode::SectionPath::is_root

pub fn is_root(&self) -> bool

Returns

bool

source

method`local_name`¶source

vihaco_bytecode::SectionPath::local_name

pub fn local_name(&self) -> Option<&str>

Returns

Option<&str>

source

method`root`¶source

vihaco_bytecode::SectionPath::root

pub fn root() -> Self

Returns

Self

source

class`SstFile`¶source

vihaco_bytecode::SstFile

Bases: Debug, Clone

Rust struct. A parsed SST file.

pub struct SstFile<C>

source

method`context`¶source

vihaco_bytecode::SstFile::context

pub fn context(&self) -> &C

Returns

&C

source

method`context_handle`¶source

vihaco_bytecode::SstFile::context_handle

pub fn context_handle(&self) -> ContextHandle<C>

Returns

ContextHandle<C>

source

method`from_text`¶source

vihaco_bytecode::SstFile::from_text

pub fn from_text(text: &str) -> Result<Self>

Parameters

Name	Type	Description
`text`	`&str`

Returns

Result<Self>

Parse an SST file from text.

source

method`root`¶source

vihaco_bytecode::SstFile::root

pub fn root(&self) -> SstSectionView<'_, C>

Returns

SstSectionView<'_, C>

The view of the root of the SST section tree.

source

class`SstSectionView`¶source

vihaco_bytecode::SstSectionView

Bases: Clone, Debug

Rust struct. A lightweight view into a parsed SST section.

pub struct SstSectionView<'bc, C>

source

method`child`¶source

vihaco_bytecode::SstSectionView::child

pub fn child(&self, local_name: &str) -> Option<SstSectionView<'bc, C>>

Parameters

Name	Type	Description
`local_name`	`&str`

Returns

Option<SstSectionView<'bc, C>>

source

method`children`¶source

vihaco_bytecode::SstSectionView::children

pub fn children(&self) -> impl Iterator + '_

Returns

impl Iterator + '_

source

method`context_handle`¶source

vihaco_bytecode::SstSectionView::context_handle

pub fn context_handle(&self) -> ContextHandle<C>

Returns

ContextHandle<C>

source

method`display_path`¶source

vihaco_bytecode::SstSectionView::display_path

pub fn display_path(&self) -> &'bc SectionPath

Returns

&'bc SectionPath

source

method`header_text`¶source

vihaco_bytecode::SstSectionView::header_text

pub fn header_text(&self) -> &'bc str

Returns

&'bc str

source

method`local_name`¶source

vihaco_bytecode::SstSectionView::local_name

pub fn local_name(&self) -> Option<&str>

Returns

Option<&str>

source

method`parse_header`¶source

vihaco_bytecode::SstSectionView::parse_header

pub fn parse_header<H: SstHeader>(&self) -> Result<H>

Returns

Result<H>

Parse the specified composite header from SST header text.

source

method`path`¶source

vihaco_bytecode::SstSectionView::path

pub fn path(&self) -> &'bc SectionPath

Returns

&'bc SectionPath

source

method`sst`¶source

vihaco_bytecode::SstSectionView::sst

pub fn sst(&self) -> &'bc str

Returns

&'bc str

source

class`BytecodeGlobalContext`¶source

vihaco_bytecode::BytecodeGlobalContext

Rust trait. A global context that can be decoded from bytecode.

pub trait BytecodeGlobalContext: Sized + SectionNameResolver

source

method`from_bytes`¶source

vihaco_bytecode::BytecodeGlobalContext::from_bytes

fn from_bytes(bytes: &[u8]) -> Result<Self>

Parameters

Name	Type	Description
`bytes`	`&[u8]`

Returns

Result<Self>

source

class`BytecodeHeader`¶source

vihaco_bytecode::BytecodeHeader

Rust trait.

pub trait BytecodeHeader: Sized + FromBytes

source

class`GlobalContext`¶source

vihaco_bytecode::GlobalContext

Rust trait. A global context that supports both bytecode and SST representations.

pub trait GlobalContext: BytecodeGlobalContext + SstGlobalContext

source

class`SectionNameResolver`¶source

vihaco_bytecode::SectionNameResolver

Rust trait. Resolve section-name indexes stored in bytecode files.

pub trait SectionNameResolver

Bytecode child section entries store section names indirectly, so parsing a bytecode file needs a context object that can resolve those indexes.

source

method`section_name`¶source

vihaco_bytecode::SectionNameResolver::section_name

fn section_name(&self, index: u32) -> Option<&str>

Parameters

Name	Type	Description
`index`	`u32`

Returns

Option<&str>

source

class`SstGlobalContext`¶source

vihaco_bytecode::SstGlobalContext

Rust trait. A global context that can be parsed from SST text.

pub trait SstGlobalContext: Sized

source

method`from_text`¶source

vihaco_bytecode::SstGlobalContext::from_text

fn from_text(text: &str) -> Result<Self>

Parameters

Name	Type	Description
`text`	`&str`

Returns

Result<Self>

source

class`SstHeader`¶source

vihaco_bytecode::SstHeader

Rust trait.

pub trait SstHeader: Sized + FromText

source

class`WriteBytecodeHeader`¶source

vihaco_bytecode::WriteBytecodeHeader

Rust trait.

pub trait WriteBytecodeHeader: WriteBytes

source

property`FLAGS`¶

vihaco_bytecode::FLAGS

pub const FLAGS: u16

property`MAGIC`¶

vihaco_bytecode::MAGIC

pub const MAGIC: &[u8; 4]

property`VERSION`¶

vihaco_bytecode::VERSION

pub const VERSION: u16

function`decode_instruction_stream`¶source

vihaco_bytecode::decode_instruction_stream

Signature

pub fn decode_instruction_stream<I: Instruction>(bytes: &[u8]) -> Result<Vec<I>>

Parameters

Name	Type	Description
`bytes`	`&[u8]`

Returns

Result<Vec<I>>

source

vihaco_bytecode (crate)

vihaco_bytecode¶

classBytecodeFile¶source

methodcontext¶source

methodcontext_handle¶source

methodfrom_bytes¶source

methodroot¶source

classBytecodeSectionView¶source

methodbytecode¶source

methodchild¶source

methodchildren¶source

methodcontext_handle¶source

methoddecode_header¶source

methoddecode_instructions¶source

methoddisplay_path¶source

methodheader_bytes¶source

methodlocal_name¶source

methodpath¶source

classConstantId¶source

classContextHandle¶source

methodget¶source

methodnew¶source

methodptr_eq¶source

classNoContext¶source

classSectionPath¶source

methodcomponents¶source

methodis_root¶source

methodlocal_name¶source

methodroot¶source

classSstFile¶source

methodcontext¶source

methodcontext_handle¶source

methodfrom_text¶source

methodroot¶source

classSstSectionView¶source

methodchild¶source

methodchildren¶source

methodcontext_handle¶source

methoddisplay_path¶source

methodheader_text¶source

methodlocal_name¶source

methodparse_header¶source

methodpath¶source

methodsst¶source

classBytecodeGlobalContext¶source

methodfrom_bytes¶source

classBytecodeHeader¶source

classGlobalContext¶source

classSectionNameResolver¶source

methodsection_name¶source

classSstGlobalContext¶source

methodfrom_text¶source

classSstHeader¶source

classWriteBytecodeHeader¶source

propertyFLAGS¶

propertyMAGIC¶

propertyVERSION¶

functiondecode_instruction_stream¶source

`vihaco_bytecode`¶

class`BytecodeFile`¶source

method`context`¶source

method`context_handle`¶source

method`from_bytes`¶source

method`root`¶source

class`BytecodeSectionView`¶source

method`bytecode`¶source

method`child`¶source

method`children`¶source

method`context_handle`¶source

method`decode_header`¶source

method`decode_instructions`¶source

method`display_path`¶source

method`header_bytes`¶source

method`local_name`¶source

method`path`¶source

class`ConstantId`¶source

class`ContextHandle`¶source

method`get`¶source

method`new`¶source

method`ptr_eq`¶source

class`NoContext`¶source

class`SectionPath`¶source

method`components`¶source

method`is_root`¶source

method`local_name`¶source

method`root`¶source

class`SstFile`¶source

method`context`¶source

method`context_handle`¶source

method`from_text`¶source

method`root`¶source

class`SstSectionView`¶source

method`child`¶source

method`children`¶source

method`context_handle`¶source

method`display_path`¶source

method`header_text`¶source

method`local_name`¶source

method`parse_header`¶source

method`path`¶source

method`sst`¶source

class`BytecodeGlobalContext`¶source

method`from_bytes`¶source

class`BytecodeHeader`¶source

class`GlobalContext`¶source

class`SectionNameResolver`¶source

method`section_name`¶source

class`SstGlobalContext`¶source

method`from_text`¶source

class`SstHeader`¶source

class`WriteBytecodeHeader`¶source

property`FLAGS`¶

property`MAGIC`¶

property`VERSION`¶

function`decode_instruction_stream`¶source