Struct ObjectBuilder

pub struct ObjectBuilder<Base: BaseType> { /* private fields */ }

An object builder, for constructing objects using a builder API.

Implementations

impl<Base: BaseType> ObjectBuilder<Base>

pub fn new(spec: ObjectCreate) -> Self

Make a new object builder.

pub fn persist(self, persist: bool) -> Self

Make the object persistent.

pub fn cast<U: BaseType>(self) -> ObjectBuilder<U>

Cast the base type.

pub fn add_src(self, obj_src: ObjectSource) -> Self

Add a Source Object that this new object will copy from.

pub fn add_tie(self, tie: CreateTieSpec) -> Self

Add a tie specification for this object creation.

pub fn named(self, name: impl ToString) -> Self

impl<Base: BaseType + StoreCopy> ObjectBuilder<Base>

pub fn build(&self, base: Base) -> Result<Object<Base>>

Build an object using the provided base value.

Panics

This function may panic if the default permissions dont contain READ and WRITE. If your usecase requires that the default permissions for an object can’t contain those flags, please look at the twizzler_security::SecureBuilderExt trait.

Example

let builder = ObjectBuilder::default();
let obj = builder.build(42u32).unwrap();

impl<Base: BaseType> ObjectBuilder<Base>

pub fn build_inplace<F>(&self, ctor: F) -> Result<Object<Base>>

where F: FnOnce(TxObject<MaybeUninit<Base>>) -> Result<TxObject<Base>>,

Build an object using the provided constructor function.

The constructor should call the .write() method on the TxObject, and return the result.

Example

let builder = ObjectBuilder::default();
let obj = builder.build_inplace(|tx| tx.write(42u32)).unwrap();

pub unsafe fn build_ctor<F>(&self, ctor: F) -> Result<Object<Base>>

where F: FnOnce(&mut TxObject<MaybeUninit<Base>>),

Build an object using the provided constructor function.

The constructor should call the .write() method on the TxObject or otherwise ensure that it is safe to call .assume_init on the underlying MaybeUninit.

Safety

The caller must ensure that the base is initialized, see MaybeUninit::assume_init.

Example

let builder = ObjectBuilder::default();
let obj = unsafe {
    builder
        .build_ctor(|tx| {
            tx.write(42u32);
        })
        .unwrap()
};

Trait Implementations

impl<Base: Clone + BaseType> Clone for ObjectBuilder<Base>

fn clone(&self) -> ObjectBuilder<Base>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Base: BaseType> Default for ObjectBuilder<Base>

fn default() -> Self

Returns the “default value” for a type.