Struct runestick::AnyObj

#[repr(C)]pub struct AnyObj { /* fields omitted */ }

Our own private dynamic Any implementation.

In contrast to Box<dyn std::any::Any>, this allows for storing a raw pointer directly in the object to avoid one level of indirection. Otherwise it's equivalent.

Implementations

impl AnyObj

pub fn new<T>(data: T) -> Self where
    T: Any, 

Construct a new any from the original any.

pub fn from_ref<T>(data: &T) -> Self where
    T: Any, 

Construct an Any that wraps a pointer.

pub fn from_mut<T>(data: &mut T) -> Self where
    T: Any, 

Construct an Any that wraps a mutable pointer.

pub unsafe fn new_raw(vtable: &'static AnyObjVtable, data: *const ()) -> Self

Construct a new any with the specified raw components.

Safety

The caller must ensure that the vtable matches up with the data pointer provided. This is primarily public for use in a C ffi.

pub fn is<T>(&self) -> bool where
    T: Any, 

Returns true if the boxed type is the same as T.

Examples

use runestick::Any;

#[derive(Debug, Any)]
struct Foo;

#[derive(Debug, Any)]
struct Other;

let any = runestick::AnyObj::new(Foo);

assert!(any.is::<Foo>());
assert!(!any.is::<Other>());

pub fn downcast_borrow_ref<T>(&self) -> Option<&T> where
    T: Any, 

Returns some reference to the boxed value if it is of type T, or None if it isn't.

Examples

use runestick::Any;

#[derive(Debug, PartialEq, Eq, Any)]
struct Thing(u32);

#[derive(Debug, PartialEq, Eq, Any)]
struct Other;

let any = runestick::AnyObj::new(Thing(1u32));
assert_eq!(Some(&Thing(1u32)), any.downcast_borrow_ref::<Thing>());
assert_eq!(None, any.downcast_borrow_ref::<Other>());

pub fn downcast_borrow_mut<T>(&mut self) -> Option<&mut T> where
    T: Any, 

Returns some mutable reference to the boxed value if it is of type T, or None if it isn't.

Examples

use runestick::Any;

#[derive(Debug, PartialEq, Eq, Any)]
struct Thing(u32);

let mut any = runestick::AnyObj::new(Thing(1u32));
any.downcast_borrow_mut::<Thing>().unwrap().0 = 2;
assert_eq!(Some(&Thing(2u32)), any.downcast_borrow_ref::<Thing>());

pub fn raw_as_ptr(&self, expected: Hash) -> Option<*const ()>

Attempt to perform a conversion to a raw pointer.

pub fn raw_as_mut(&mut self, expected: Hash) -> Option<*mut ()>

Attempt to perform a conversion to a raw mutable pointer.

pub fn raw_take(self, expected: Hash) -> Result<*mut (), Self>

Attempt to perform a conversion to a raw mutable pointer with the intent of taking it.

If the conversion is not possible, we return a reconstructed Any as the error variant.

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

Debug format the current any type.

pub fn type_name(&self) -> RawStr

Access the underlying type name for the data.

pub fn type_hash(&self) -> Hash

Access the underlying type id for the data.

Trait Implementations

impl Debug for AnyObj

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

Formats the value using the given formatter.

impl Drop for AnyObj

fn drop(&mut self)

Executes the destructor for this type.

impl From<AnyObj> for Value

fn from(value: AnyObj) -> Self

Performs the conversion.

impl ToValue for AnyObj

fn to_value(self) -> Result<Value, VmError>

Convert into a value.