Struct magnus::value::BoxValue

pub struct BoxValue<T>(_);

Protects a Ruby Value from the garbage collector.

See also Value::leak for a value that should be permanently excluded from garbage collection.

All Value methods should be available on this type through Deref, but some may be missed by this documentation.

Implementations

impl<T> BoxValue<T> where
    T: ReprValue, 

pub fn new(val: T) -> Self

Create a new BoxValue.

Examples

use magnus::{eval, gc, value::BoxValue, RString, Value};

fn box_value() -> BoxValue<RString> {
    BoxValue::new(RString::new("foo"))
}

let boxed = box_value();

// run garbage collector
gc::start();

// boxed is still useable
let result: String = eval!(r#"foo + "bar""#, foo = boxed).unwrap();

assert_eq!(result, "foobar");

Trait Implementations

impl<T> AsMut<T> for BoxValue<T>

fn as_mut(&mut self) -> &mut T

Converts this type into a mutable reference of the (usually inferred) input type.

impl<T> AsRef<T> for BoxValue<T>

fn as_ref(&self) -> &T

Converts this type into a shared reference of the (usually inferred) input type.

impl<T> Debug for BoxValue<T> where
    T: ReprValue, 

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

Formats the value using the given formatter.

impl<T> Deref for BoxValue<T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<T> DerefMut for BoxValue<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<T> Display for BoxValue<T> where
    T: ReprValue, 

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

Formats the value using the given formatter.

impl<T> Drop for BoxValue<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> From<BoxValue<T>> for Value where
    T: ReprValue, 

fn from(val: BoxValue<T>) -> Self

Converts to this type from the input type.