Struct r3_core::bind::BindDefiner

pub struct BindDefiner<System, Binder, Func> { /* private fields */ }

The definer (static builder) for Bind.

Implementations

impl<System> BindDefiner<System, BinderUnspecified, FuncUnspecified>

Specifying the initializer function

One of the following methods should be used to specify the initializer for the binding being defined.

pub const fn init<Func>(self, func: Func) -> BindDefiner<System, (), Func>

Use the function to initialize the binding contents.

pub const fn init_with_bind<Binder, Func>( self, binder: Binder, func: Func ) -> BindDefiner<System, Binder, Func>

Use the function with dependency to initialize the binding contents.

pub const fn zeroed<T: Zeroable>( self ) -> BindDefiner<System, (), FnBindNever<T>>

Zero-initialize the binding contents.

pub const unsafe fn zeroed_unchecked<T>( self ) -> BindDefiner<System, (), FnBindNever<T>>

Zero-initialize the binding contents even if it might be unsafe.

Safety

If zero initialization is not a valid bit pattern for T, accessing the contents may result in an undefined behavior.

pub const unsafe fn uninit_unchecked<T>( self ) -> BindDefiner<System, (), FnBindNever<T>>

Skip the initialization of the binding contents even if it might be unsafe.

Safety

If the uninitialized state is not valid for T, accessing the contents may result in an undefined behavior.

impl<System, Binder, Func> BindDefiner<System, Binder, Func>

Optional Parameters

pub const fn unpure(self) -> Self

Indicate that the evaluation of the initializer may cause a side-effect that the dependency solver must not remove implicitly.

Unimplemented: Pruning unused bindings is not implemented yet. Therefore, this method is no-op.

impl<System, Binder, Func> BindDefiner<System, Binder, Func>

Finalization

The following method defines a binding using the provided parameter.

pub const fn finish<'pool, C>( self, cfg: &mut Cfg<'pool, C> ) -> Bind<'pool, System, <Func as FnBind<Binder>>::Output>where C: CfgBase<System = System>, System: KernelBase + KernelStatic, Func: FnBind<Binder>,

Complete the definition of a binding, returning a reference to it.