Trait artichoke_backend::extn::prelude::BoxUnboxVmValue

pub trait BoxUnboxVmValue {
    type Unboxed;
    type Guarded;

    const RUBY_TYPE: &'static str;

    unsafe fn unbox_from_value<'a>(
        value: &'a mut Value, 
        interp: &mut Artichoke
    ) -> Result<UnboxedValueGuard<'a, Self::Guarded>, Error>;
    fn alloc_value(
        value: Self::Unboxed, 
        interp: &mut Artichoke
    ) -> Result<Value, Error>;
    fn box_into_value(
        value: Self::Unboxed, 
        into: Value, 
        interp: &mut Artichoke
    ) -> Result<Value, Error>;
    fn free(data: *mut c_void);
}

Required Associated Types

type Unboxed

type Guarded

Required Associated Constants

const RUBY_TYPE: &'static str

Required Methods

unsafe fn unbox_from_value<'a>(
    value: &'a mut Value,
    interp: &mut Artichoke
) -> Result<UnboxedValueGuard<'a, Self::Guarded>, Error>

Safety

Implementations may return owned values. These values must not outlive the underlying mrb_value, which may be garbage collected by mruby.

The values returned by this method should not be stored for more than the current FFI trampoline entry point.

fn alloc_value(
    value: Self::Unboxed,
    interp: &mut Artichoke
) -> Result<Value, Error>

fn box_into_value(
    value: Self::Unboxed,
    into: Value,
    interp: &mut Artichoke
) -> Result<Value, Error>

fn free(data: *mut c_void)

Implementations on Foreign Types

impl BoxUnboxVmValue for String

type Unboxed = String

type Guarded = String

const RUBY_TYPE: &'static str = "String"

unsafe fn unbox_from_value<'a>(
    value: &'a mut Value,
    interp: &mut Artichoke
) -> Result<UnboxedValueGuard<'a, Self::Guarded>, Error>

fn alloc_value(
    value: Self::Unboxed,
    interp: &mut Artichoke
) -> Result<Value, Error>

fn box_into_value(
    value: Self::Unboxed,
    into: Value,
    interp: &mut Artichoke
) -> Result<Value, Error>

fn free(data: *mut c_void)

Implementors

impl BoxUnboxVmValue for Array

type Unboxed = Array

type Guarded = Array

const RUBY_TYPE: &'static str = "Array"

impl BoxUnboxVmValue for Symbol

type Unboxed = Symbol

type Guarded = Immediate<<Symbol as BoxUnboxVmValue>::Unboxed>

const RUBY_TYPE: &'static str = "Symbol"

impl<T> BoxUnboxVmValue for T where
    T: HeapAllocatedData + Sized + 'static, 

type Unboxed = T

type Guarded = HeapAllocated<<T as BoxUnboxVmValue>::Unboxed>

const RUBY_TYPE: &'static str = ::RUBY_TYPE