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 u8

Get a pointer to the metadata structure.

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) -> Self

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: u32, ) -> Self

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 Clone for ObjectHandle

fn clone(&self) -> Self

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

Formats the value using the given formatter.

impl Drop for ObjectHandle

fn drop(&mut self)

Executes the destructor for this type.

impl Send for ObjectHandle

impl Sync for ObjectHandle