Struct rosy::vm::InstrSeq

#[repr(transparent)]
pub struct InstrSeq(_);

An instance of Ruby's RubyVM::InstructionSequence class.

Note: The binary data that comes from an instruction sequence is not portable and should not be used in another version or architecture of Ruby.

Methods

impl InstrSeq

pub fn compile(script: impl Into<String>) -> Result<Self>

Compiles script into an instruction sequence.

pub fn compile_with(
    script: impl Into<String>,
    options: impl Into<Hash>
) -> Result<Self>

Compiles script with options into an instruction sequence.

pub fn compile_file(path: impl Into<String>) -> Result<Self>

Compiles the contents of a file at path into an instruction sequence.

pub fn compile_file_with(
    path: impl Into<String>,
    options: impl Into<Hash>
) -> Result<Self>

Compiles the contents of a file at path with `options into an instruction sequence.

pub unsafe fn from_binary(binary: impl Into<String>) -> Self

Loads an instruction sequence from a binary formatted string created by to_binary.

Safety

This loader does not have a verifier, so loading broken/modified binary causes critical problems.

Examples

This is equivalent to calling RubyVM::InstructionSequence.load_from_binary:

use rosy::{vm::InstrSeq, String};

let script = "'hi' * 3";

let seq1 = InstrSeq::compile(script).expect("Invalid script");
let seq2 = unsafe { InstrSeq::from_binary(seq1.to_binary()) };

assert_eq!(String::from("hihihi"), unsafe { seq2.eval() });

pub unsafe fn eval(self) -> AnyObject

Evaluates self and returns the result.

Safety

Code executed from self may void the type safety of objects accessible from Rust. For example, if one calls push on an Array<A> with an object of type B, then the inserted object will be treated as being of type A.

If this instruction sequence throws an exception, it must be caught.

pub fn eval_protected(self) -> Result<AnyObject>

Evaluates self and returns the result.

Safety

Code executed from self may void the type safety of objects accessible from Rust. For example, if one calls push on an Array<A> with an object of type B, then the inserted object will be treated as being of type A.

Examples

This is equivalent to calling eval in a protected context:

use rosy::{vm::InstrSeq, String};

let script = "'hi' * 3";
let instr_seq = InstrSeq::compile(script).expect("Invalid script");

let output = unsafe { instr_seq.eval_protected().unwrap() };
assert_eq!(String::from("hihihi"), output);

pub fn to_binary(self) -> String

Returns the serialized binary data.

pub fn write_binary(self, w: impl Write) -> Result<()>

Writes the serialized binary data of self to w.

This makes it easy to write the contents of self to a File or any other common I/O type.

pub fn disassemble(self) -> String

Returns a human-readable form of self.

pub fn path(self) -> String

Returns the file path of self, or <compiled> if it was compiled from a string.

pub fn absolute_path(self) -> Option<String>

Returns the absolute path of self if it was compiled from a file.

Trait Implementations

impl Classify for InstrSeq

fn class() -> Class<Self>

Returns the typed class that can be used to get an instance of self.

impl Object for InstrSeq

fn unique_id() -> Option<u128>

Returns a unique identifier for an object type to facilitate casting.

fn cast<A: Object>(obj: A) -> Option<Self>

Attempts to create an instance by casting obj.

unsafe fn from_raw(raw: usize) -> Self

Creates a new object from raw without checking.

unsafe fn cast_unchecked(obj: impl Object) -> Self

Casts obj to Self without checking its type.

fn into_any_object(self) -> AnyObject

Returns self as an AnyObject.

fn as_any_object(&self) -> &AnyObject

Returns a reference to self as an AnyObject.

fn as_any_slice(&self) -> &[AnyObject]

Returns self as a reference to a single-element slice.

fn raw(self) -> usize

Returns the raw object pointer.

unsafe fn as_unchecked<O: Object>(&self) -> &O

Casts self to O without checking whether it is one.

unsafe fn into_unchecked<O: Object>(self) -> O

Converts self to O without checking whether it is one.

fn id(self) -> u64

Returns the object's identifier.

fn ty(self) -> Ty

Returns the virtual type of self.

fn is_ty(self, ty: Ty) -> bool

Returns whether the virtual type of self is ty.

fn class(self) -> Class<Self>

Returns the Class for self.

fn singleton_class(self) -> Class<Self>

Returns the singleton Class of self, creating one if it doesn't exist already.

fn mark(self)

Marks self for Ruby to avoid garbage collecting it.

unsafe fn force_recycle(self)

Forces the garbage collector to free the contents of self.

fn def_singleton_method<N, F>(self, name: N, f: F) -> Result where
    N: Into<SymbolId>,
    F: MethodFn<Self>, 

Defines a method for name on the singleton class of self that calls f when invoked.

unsafe fn def_singleton_method_unchecked<N, F>(self, name: N, f: F) where
    N: Into<SymbolId>,
    F: MethodFn<Self>, 

Defines a method for name on the singleton class of self that calls f when invoked.

unsafe fn call(self, method: impl Into<SymbolId>) -> AnyObject

Calls method on self and returns its output.

unsafe fn call_protected(self, method: impl Into<SymbolId>) -> Result<AnyObject>

Calls method on self and returns its output, or an exception if one is raised.

unsafe fn call_with(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> AnyObject

Calls method on self with args and returns its output.

unsafe fn call_with_protected(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> Result<AnyObject>

Calls method on self with args and returns its output, or an exception if one is raised.

unsafe fn call_public(self, method: impl Into<SymbolId>) -> AnyObject

Calls the public method on self and returns its output.

unsafe fn call_public_protected(
    self,
    method: impl Into<SymbolId>
) -> Result<AnyObject>

Calls the public method on self and returns its output, or an exception if one is raised.

unsafe fn call_public_with(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> AnyObject

Calls the public method on self with args and returns its output.

unsafe fn call_public_with_protected(
    self,
    method: impl Into<SymbolId>,
    args: &[impl Object]
) -> Result<AnyObject>

Calls the public method on self with args and returns its output, or an exception if one is raised.

fn inspect(self) -> String

Returns a printable string representation of self.

fn to_s(self) -> String

Returns the result of calling the to_s method on self.

fn is_frozen(self) -> bool

Returns whether modifications can be made to self.

fn freeze(self)

Freezes self, preventing any further mutations.

fn is_eql<O: Object>(self, other: &O) -> bool

Returns whether self is equal to other in terms of the eql? method.

fn get_attr<N: Into<SymbolId>>(self, name: N) -> AnyObject

Returns the value for the attribute of self associated with name.

unsafe fn eval(self, args: impl EvalArgs) -> AnyObject

Evaluates args in the context of self.

unsafe fn eval_protected(self, args: impl EvalArgs) -> Result<AnyObject>

Evaluates args in the context of self, returning any raised exceptions.

impl PartialEq<AnyObject> for InstrSeq

fn eq(&self, obj: &AnyObject) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use]

fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Copy for InstrSeq

impl Clone for InstrSeq

fn clone(&self) -> InstrSeq

Returns a copy of the value.

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

Performs copy-assignment from source.

impl AsRef<AnyObject> for InstrSeq

fn as_ref(&self) -> &AnyObject

Performs the conversion.

impl From<InstrSeq> for AnyObject

fn from(obj: InstrSeq) -> Self

Performs the conversion.

impl Debug for InstrSeq

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

Formats the value using the given formatter.

impl Display for InstrSeq

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

Formats the value using the given formatter.