Struct Object

pub struct Object<Base> { /* private fields */ }

Implementations

impl<Base> Object<Base>

pub fn into_tx(self) -> Result<TxObject<Base>>

Start a transaction on this object, turning this object into a transaction object handle.

Example

let obj = ObjectBuilder::new().build(12u32).unwrap();
let tx_obj = obj.into_tx().unwrap();
tx_obj.base_mut() += 1;

pub fn as_tx(&self) -> Result<TxObject<Base>>

Start a transaction on this object, creating a new transaction object handle.

Example

let obj = ObjectBuilder::new().build(12u32).unwrap();
let tx_obj = obj.as_tx().unwrap();
tx_obj.base_mut() += 1;

pub fn with_tx<R>( &mut self, f: impl FnOnce(&mut TxObject<Base>) -> Result<R>, ) -> Result<R>

Perform a transaction on this object, within the provided closure.

Example

let obj = ObjectBuilderrstarst::new().build(12u32).unwrap();
obj.with_tx(|tx| tx.base_mut() += 1).unwrap();

pub unsafe fn as_mut(&self) -> Result<MutObject<Base>>

Create a new mutable object handle from this object.

Safety

The caller must ensure that the underlying object is not changed outside of this mapping.

pub unsafe fn into_mut(self) -> Result<MutObject<Base>>

Create a new mutable object handle from this object.

Safety

The caller must ensure that the underlying object is not changed outside of this mapping.

pub unsafe fn from_handle_unchecked(handle: ObjectHandle) -> Self

pub fn from_handle(handle: ObjectHandle) -> Result<Self>

pub fn into_handle(self) -> ObjectHandle

pub unsafe fn cast<U>(self) -> Object<U>

pub fn map(id: ObjID, flags: MapFlags) -> Result<Self>

Open a new object from its ID.

The provided map flags must contain at least READ, and for stable read maps, INDIRECT. For writes, add WRITE and PERSIST.

This function checks the underlying fingerprint of the base type against the stored value and fails on mismatch to ensure type safety.

pub unsafe fn map_unchecked(id: ObjID, flags: MapFlags) -> Result<Self>

Open a new object from its ID without checking the underlying fingerprint.

Safety

This function is unsafe because it does not check the underlying fingerprint of the base type against the stored value. Use with caution.

pub fn id(&self) -> ObjID

Return the ID of the object.

pub fn update(&mut self) -> Result<()>

Update the underlying mapping of the object. This invalidates all references to the object (hence why it takes &mut self).

Trait Implementations

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<B> Clone for Object<B>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<B> From<MutObject<B>> for Object<B>

fn from(mut_obj: MutObject<B>) -> Self

Converts to this type from the input type.

impl<T: Invariant, A: Allocator> From<Object<Vec<T, A>>> for VecObject<T, A>

fn from(value: Object<Vec<T, A>>) -> Self

Converts to this type from the input type.

impl<Base> RawObject for Object<Base>

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<Base: BaseType> TypedObject for Object<Base>

type Base = Base

The base type of this object.

fn base_ref(&self) -> Ref<'_, Self::Base>

Returns a resolved reference to the object’s base.

fn base(&self) -> &Self::Base

impl<Base> Send for Object<Base>

impl<Base> Sync for Object<Base>