Struct UnsafeBytecodeStream

pub struct UnsafeBytecodeStream(/* private fields */);

Available on crate feature decode only.

An unsafe bytecode stream.

This is a wrapper over a raw pointer to bytecode somewhere in memory.

Implementations

impl UnsafeBytecodeStream

pub unsafe fn new(pc: NonNull<u8>) -> Self

Construct a new UnsafeBytecodeStream pointing at the given PC.

Safety

The given pc must point to valid Pulley bytecode, and it is the caller’s responsibility to ensure that the resulting UnsafeBytecodeStream is only used to access the valid bytecode. For example, if the current bytecode instruction unconditionally jumps to a new PC, this stream must not be used to read just after the unconditional jump instruction because there is no guarantee that that memory is part of the bytecode stream or not.

pub unsafe fn offset(&self, offset: isize) -> Self

Get a new UnsafeBytecodeStream pointing at the bytecode that is at the given relative offset from this stream’s current position.

Safety

Same as the new constructor. May only be used when it is guaranteed that the address at self._as_ptr() + offset contains valid Pulley bytecode.

pub fn as_ptr(&self) -> NonNull<u8>

Get this stream’s underlying raw pointer.

Trait Implementations

impl BytecodeStream for UnsafeBytecodeStream

type Error = Uninhabited

The type of error that this bytecode stream produces on invalid operations.

fn read<const N: usize>(&mut self) -> Result<[u8; N], Self::Error>

Read N bytes from this bytecode stream, advancing the stream’s position at the same time.

fn unexpected_eof(&self) -> Self::Error

Create an “unexpected end-of-stream” error at the current position.

fn invalid_opcode(&self, _code: u8) -> Self::Error

Create an “invalid opcode” error at the current position.

fn invalid_extended_opcode(&self, _code: u16) -> Self::Error

Create an “invalid extended opcode” error at the current position.

fn invalid_reg(&self, _reg: u8) -> Self::Error

Create an “invalid register” error at the current position.

impl Clone for UnsafeBytecodeStream

fn clone(&self) -> UnsafeBytecodeStream

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for UnsafeBytecodeStream

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

Formats the value using the given formatter.

impl Copy for UnsafeBytecodeStream