Struct Any

#[repr(C)]
pub struct Any { /* private fields */ }

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 Any

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

where T: Any,

Construct a new any from the original any.

pub unsafe fn from_ptr<T>(data: *const T) -> Self

where T: Any,

Construct a new any from a pointer.

Safety

It is up to the caller to make sure that whatever data is pointed to is valid for the duration of the Any.

Examples

let value = 1u32;
let any = unsafe { stk::Any::from_ptr(&value) };
assert!(any.is::<u32>());
assert_eq!(Some(&1u32), any.downcast_ref());

pub unsafe fn from_mut_ptr<T>(data: *mut T) -> Self

where T: Any,

Construct a new any from a mutable pointer.

Safety

It is up to the caller to make sure that whatever data is pointed to is valid for the duration of the Any.

Examples

let mut value = 1u32;
let mut any = unsafe { stk::Any::from_mut_ptr(&mut value) };
assert!(any.is::<u32>());
*any.downcast_mut::<u32>().unwrap() = 2;
assert_eq!(Some(&2u32), any.downcast_ref());

pub fn is<T>(&self) -> bool

where T: Any,

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

Examples

let any = stk::Any::new(1u32);
assert!(any.is::<u32>());

pub fn downcast_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

let any = stk::Any::new(1u32);
assert_eq!(Some(&1u32), any.downcast_ref::<u32>());
assert_eq!(None, any.downcast_ref::<&u32>());

pub fn downcast_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

let mut any = stk::Any::new(1u32);
*any.downcast_mut::<u32>().unwrap() = 2;
assert_eq!(Some(&2u32), any.downcast_ref::<u32>());

pub fn as_ptr(&self, expected_type: TypeId) -> Option<*const ()>

Attempt to perform a conversion to a raw pointer.

pub fn as_mut_ptr(&mut self, expected_type: TypeId) -> Option<*mut ()>

Attempt to perform a conversion to a raw mutable pointer.

pub fn take_mut_ptr(self, expected_type: TypeId) -> 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 type_name(&self) -> &'static str

Access the underlying type name for the data.

pub fn type_id(&self) -> TypeId

Access the underlying type id for the data.

Trait Implementations

impl Debug for Any

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

Formats the value using the given formatter.

impl Drop for Any

fn drop(&mut self)

Executes the destructor for this type.

impl FromValue for Any

fn from_value(value: ValuePtr, vm: &mut Vm) -> Result<Self, StackError>

Try to convert to the given type, from the given value.