Struct ObjectHandle

pub struct ObjectHandle(/* private fields */);

An object handle, granting access to object memory. An object handle can be in two modes:

• Owning – the normal mode, which acts like an Arc, and asks the runtime to unmap when refcount hits zero.
• Unsafe – internal use only, is NOT owning, but still has pointers. This is totally unsafe to use, and should not be exposed to users. But sometimes, it can be safe, and faster than cloning. … anyway, in general these have reference counting semantics, via Clone and Drop, like Arc.

Implementations

impl ObjectHandle

pub fn start(&self) -> *mut u8

Get a pointer to the start of object data.

pub fn meta(&self) -> *mut MetaInfo

Get a pointer to the metadata structure.

pub fn meta_exts(&self) -> &[MetaExt]

Get a slice of metadata extensions

pub fn find_meta_ext(&self, tag: MetaExtTag) -> Option<&MetaExt>

Find the first metadata extension matching the given tag

pub fn runtime_info(&self) -> *mut u8

Get a pointer to the runtime info.

pub fn map_flags(&self) -> MapFlags

Get map flags.

pub fn valid_len(&self) -> usize

Get the number of valid bytes after start pointer for object data.

pub fn id(&self) -> ObjID

Get the object ID.

pub fn into_raw(self) -> object_handle

Get the raw object handle.

pub fn from_raw(raw: object_handle) -> ObjectHandle

Build an object handle from raw.

pub unsafe fn new( id: ObjID, runtime_info: *mut c_void, start: *mut c_void, meta: *mut c_void, map_flags: MapFlags, valid_len: usize, ) -> ObjectHandle

Make a new object handle.

Safety

The caller must ensure that runtime_info is a valid pointer, and points to a repr(C) struct that starts with an AtomicU64 for reference counting.

Trait Implementations

impl AsRef<ObjectHandle> for ArenaObject

fn as_ref(&self) -> &ObjectHandle

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

impl<T> AsRef<ObjectHandle> for MutObject<T>

fn as_ref(&self) -> &ObjectHandle

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

impl<T> AsRef<ObjectHandle> for Object<T>

fn as_ref(&self) -> &ObjectHandle

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

impl AsRef<ObjectHandle> for ObjectHandle

fn as_ref(&self) -> &ObjectHandle

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

impl<'a, T> AsRef<ObjectHandle> for Ref<'a, T>

fn as_ref(&self) -> &ObjectHandle

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

impl<'a, T> AsRef<ObjectHandle> for RefMut<'a, T>

fn as_ref(&self) -> &ObjectHandle

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

impl<'a, T> AsRef<ObjectHandle> for RefSlice<'a, T>

fn as_ref(&self) -> &ObjectHandle

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

impl<'a, T> AsRef<ObjectHandle> for RefSliceMut<'a, T>

fn as_ref(&self) -> &ObjectHandle

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

impl<B> AsRef<ObjectHandle> for TxObject<B>

fn as_ref(&self) -> &ObjectHandle

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

impl<T> AsRef<ObjectHandle> for TxRef<T>

fn as_ref(&self) -> &ObjectHandle

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

impl<T> AsRef<ObjectHandle> for TxRefSlice<T>

fn as_ref(&self) -> &ObjectHandle

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

impl Clone for ObjectHandle

fn clone(&self) -> ObjectHandle

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ObjectHandle

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

Formats the value using the given formatter.

impl Drop for ObjectHandle

fn drop(&mut self)

Executes the destructor for this type.

impl<'a, T> Into<ObjectHandle> for &Ref<'a, T>

fn into(self) -> ObjectHandle

Converts this type into the (usually inferred) input type.

impl<'a, T> Into<ObjectHandle> for &RefMut<'a, T>

fn into(self) -> ObjectHandle

Converts this type into the (usually inferred) input type.

impl<'a, T> Into<ObjectHandle> for &RefSlice<'a, T>

fn into(self) -> ObjectHandle

Converts this type into the (usually inferred) input type.

impl<'a, T> Into<ObjectHandle> for &RefSliceMut<'a, T>

fn into(self) -> ObjectHandle

Converts this type into the (usually inferred) input type.

impl<B> Into<ObjectHandle> for &TxObject<B>

fn into(self) -> ObjectHandle

Converts this type into the (usually inferred) input type.

impl<T> Into<ObjectHandle> for &TxRef<T>

fn into(self) -> ObjectHandle

Converts this type into the (usually inferred) input type.

impl<T> Into<ObjectHandle> for &TxRefSlice<T>

fn into(self) -> ObjectHandle

Converts this type into the (usually inferred) input type.

impl<'a, T> Into<ObjectHandle> for Ref<'a, T>

fn into(self) -> ObjectHandle

Converts this type into the (usually inferred) input type.

impl<'a, T> Into<ObjectHandle> for RefMut<'a, T>

fn into(self) -> ObjectHandle

Converts this type into the (usually inferred) input type.

impl<'a, T> Into<ObjectHandle> for RefSlice<'a, T>

fn into(self) -> ObjectHandle

Converts this type into the (usually inferred) input type.

impl<'a, T> Into<ObjectHandle> for RefSliceMut<'a, T>

fn into(self) -> ObjectHandle

Converts this type into the (usually inferred) input type.

impl<B> Into<ObjectHandle> for TxObject<B>

fn into(self) -> ObjectHandle

Converts this type into the (usually inferred) input type.

impl<T> Into<ObjectHandle> for TxRef<T>

fn into(self) -> ObjectHandle

Converts this type into the (usually inferred) input type.

impl<T> Into<ObjectHandle> for TxRefSlice<T>

fn into(self) -> ObjectHandle

Converts this type into the (usually inferred) input type.

impl RawObject for ObjectHandle

fn handle(&self) -> &ObjectHandle

Get the underlying runtime handle for this object.

fn id(&self) -> ObjID

Get the object ID.

fn base_ptr<T>(&self) -> *const T

Get a const pointer to the object base.

fn base_mut_ptr<T>(&self) -> *mut T

Get a mut pointer to the object base.

fn meta_ptr(&self) -> *const MetaInfo

Get a const pointer to the object metadata.

fn meta_mut_ptr(&self) -> *mut MetaInfo

Get a mut pointer to the object metadata.

fn fote_ptr(&self, idx: usize) -> Option<*const FotEntry>

Get a const pointer to a given FOT entry.

fn fote_ptr_mut(&self, idx: usize) -> Option<*mut FotEntry>

Get a mut pointer to a given FOT entry.

fn lea(&self, offset: usize, _len: usize) -> Option<*const u8>

Get a const pointer to given range of the object.

fn lea_mut(&self, offset: usize, _len: usize) -> Option<*mut u8>

Get a mut pointer to given range of the object.

fn ptr_local(&self, ptr: *const u8) -> Option<usize>

If the pointer is local to this object, return the offset into the object. Otherwise, return None.

impl Send for ObjectHandle

impl Sync for ObjectHandle