Struct twizzler_object::Object

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

A handle for an object with base type T.

Implementations

impl<T: BaseType + ObjSafe> Object<T>

pub fn base(&self) -> Result<&T, BaseError>

Get a reference to the base of an object. Checks to see if the tags and version information for the BaseType match.

impl<BaseType> Object<BaseType>

pub unsafe fn base_unchecked(&self) -> &BaseType

Get a reference to the base of an object, bypassing version and tag checks.

Safety

The caller must ensure that the base of the object really is of type BaseType.

pub unsafe fn base_mut_unchecked(&self) -> &mut BaseType

Get a mutable reference to the base of an object, bypassing version and tag checks.

Safety

The caller must ensure that the base of the object really is of type BaseType.

impl<T> Object<T>

pub fn create_with( spec: &CreateSpec, f: impl FnOnce(&mut Object<MaybeUninit<T>>) ) -> Result<Self, CreateError>

Create an object, setting up the initial value for the base in a closure.

impl<T: BaseType> Object<T>

pub fn create<A>(spec: &CreateSpec, args: A) -> Result<Self, CreateError>

Create an object, setting up the initial value for base using the BaseType’s init function.

impl<T> Object<T>

pub fn init_id( id: ObjID, prot: Protections, _flags: ObjectInitFlags ) -> Result<Self, ObjectInitError>

Initialize an object handle from an object ID.

impl<T> Object<T>

pub unsafe fn meta(&self) -> NonNull<MetaInfo>

Get a mutable reference to the object’s meta info struct.

Safety

See this crate’s base documentation (Isolation Safety).

pub unsafe fn metaext(&self) -> NonNull<MetaExt>

Get a mutable reference to the object’s first meta extension entry.

Safety

See this crate’s base documentation (Isolation Safety).

pub fn meta_nonce(&self) -> Nonce

Get the nonce of the object.

pub fn meta_kuid(&self) -> ObjID

Get the public key ID of the object.

pub fn meta_flags(&self) -> MetaFlags

Get the meta flags of the object.

pub fn meta_tag(&self) -> BaseTag

Get the base tag of the object.

pub fn meta_version(&self) -> BaseVersion

Get the base version of the object.

pub unsafe fn get_fote_unguarded(&self, idx: usize) -> *mut FotEntry

Get a mutable pointer to one of the object’s FOT entries.

Safety

See this crate’s base documentation (Isolation Safety). Additionally, the caller must ensure the index does not exceed the number of FOT entries in the object.

impl<T> Object<T>

pub fn id(&self) -> ObjID

Get the ID of this object.

pub fn slot(&self) -> &Arc<Slot>

Get the slot of this object.

pub unsafe fn transmute<N>(self) -> Object<N>

Transmute the object of base type T to base type N.

Safety

All the safely rules of using core::mem::transmute apply to the base type.

impl<T> Object<T>

pub fn raw_lea<P>(&self, off: usize) -> *const P

Get a raw pointer into an object given an offset.

pub fn raw_lea_mut<P>(&self, off: usize) -> *mut P

Get a raw mutable pointer into an object given an offset.

Trait Implementations

impl<T> Clone for Object<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Base> From<Arc<Slot, Global>> for Object<Base>

fn from(s: Arc<Slot>) -> Self

Converts to this type from the input type.