Struct Object 

pub struct Object { /* private fields */ }

A value of any registered type, held in its own allocation.

Construction and destruction go through the TypeHandle: a native type runs the Rust initializer and destructor, a runtime type walks its fields and does each one in turn.

Typed access is checked, so Object::read returns None unless the object really holds that Rust type.

Implementations

impl Object

pub fn new(handle: Arc<Type>) -> Object

Allocates a default value of the given type.

Panics

Panics when the type has no way to create a default value. Use Object::try_new to get None instead.

pub fn try_new(handle: Arc<Type>) -> Option<Object>

Object::new that returns None instead of panicking.

pub unsafe fn new_uninitialized(handle: Arc<Type>) -> Option<Object>

Allocates room for a value without creating one.

Safety

The memory holds garbage. It must be filled before the object is read or dropped, since dropping runs the type’s destructor over whatever is there.

pub unsafe fn new_raw(handle: Arc<Type>, memory: *mut u8) -> Object

Takes ownership of an existing allocation.

Safety

memory must hold an initialized value of the type, allocated so that it can be freed with the type’s layout. The object frees it on drop.

pub unsafe fn from_bytes(handle: Arc<Type>, bytes: &[u8]) -> Option<Object>

Allocates a value by copying a byte image of one.

Returns None when bytes is not exactly the size of the type.

Safety

bytes must be a valid image of a value of this type, and it is moved, so the caller must not drop the source afterwards.

pub fn with_value<T>(handle: Arc<Type>, value: T) -> Option<Object>

where T: 'static,

Moves a Rust value into an object, or returns None when handle does not describe T.

pub unsafe fn initialize(&mut self)

Writes a default value into this object’s memory.

Safety

The memory must not already hold a value, since the old one is not dropped first.

pub fn consume<T>(self) -> Result<T, Object>

where T: 'static,

Moves the value out as a Rust value, or gives the object back on a type mismatch.

pub unsafe fn into_inner(self) -> (Arc<Type>, *mut u8)

Splits into the type handle and the allocation, and stops the object from freeing it.

Safety

The caller becomes responsible for destroying the value and freeing the memory with the type’s layout.

pub fn type_handle(&self) -> &Arc<Type>

Returns the type of the stored value.

pub unsafe fn memory(&self) -> &[u8]

Returns the value as raw bytes.

Safety

Reading the bytes of a type that owns resources, or keeping them past the object’s life, is on the caller.

pub unsafe fn memory_mut(&mut self) -> &mut [u8]

Returns the value as mutable raw bytes.

Safety

Writing bytes that are not a valid value of the stored type makes every later read, and the eventual drop, undefined.

pub unsafe fn field_memory<'a>( &'a self, query: StructFieldQuery<'a>, ) -> Option<&'a [u8]>

Returns the bytes of one field, chosen by query.

For an enum, the field is looked up in the variant the value currently holds.

Safety

Same conditions as Object::memory.

pub unsafe fn field_memory_mut<'a>( &'a mut self, query: StructFieldQuery<'a>, ) -> Option<&'a mut [u8]>

Returns the mutable bytes of one field, chosen by query.

For an enum, the field is looked up in the variant the value currently holds.

Safety

Same conditions as Object::memory_mut.

pub fn read<T>(&self) -> Option<&T>

where T: 'static,

Borrows the value as a T, or returns None on a type mismatch.

pub fn write<T>(&mut self) -> Option<&mut T>

where T: 'static,

Borrows the value mutably as a T, or returns None on a type mismatch.

pub fn read_field<'a, T>(&'a self, field: &str) -> Option<&'a T>

where T: 'static,

Borrows one field by name, or returns None when there is no such field of that type.

This is how a runtime type’s fields are reached, since there is no Rust struct to go through.

pub fn write_field<'a, T>(&'a mut self, field: &str) -> Option<&'a mut T>

where T: 'static,

Mutable Object::read_field.

pub unsafe fn as_ptr(&self) -> *const u8

Returns the allocation pointer.

Safety

Nothing is checked. The caller takes over both typing and aliasing.

pub unsafe fn as_mut_ptr(&mut self) -> *mut u8

Returns the mutable allocation pointer.

Safety

Nothing is checked. The caller takes over both typing and aliasing.

pub unsafe fn prevent_drop(&mut self)

Stops this object from destroying its value when it is dropped.

Safety

The value leaks unless its ownership was already handed to someone else.

Trait Implementations

impl Debug for Object

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

Formats the value using the given formatter.

impl Drop for Object

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.