Struct r3_core::bind::Bind

pub struct Bind<'pool, System, T> { /* private fields */ }

A defined binding.

The configuration-time metadata is stored in a pool with lifetime 'pool.

Implementations

impl<'pool, System> Bind<'pool, System, ()>

pub const fn define() -> BindDefiner<System, BinderUnspecified, FuncUnspecified>

Construct a BindDefiner to define a binding in a configuration function.

impl<'pool, System, T> Bind<'pool, System, T>

Binders

The following methods are used to construct a binder, which is a reference to a binding with a specific borrowing mode.

pub const fn borrow(&self) -> BindBorrow<'pool, System, T>where
    T: Sync,

Create a BindBorrow binder, which gives &T to a bound function.

pub const fn borrow_mut(&self) -> BindBorrowMut<'pool, System, T>where
    T: Send,

Create a BindBorrowMut binder, which gives &mut T to a bound function.

pub const fn take(&self) -> BindTake<'pool, System, T>where
    T: Send,

Create a BindTake binder, which gives T to a bound function.

pub const fn take_ref(&self) -> BindTakeRef<'pool, System, T>where
    T: Sync,

Create a BindTakeRef binder, which gives &'static T to a bound function.

pub const fn take_mut(&self) -> BindTakeMut<'pool, System, T>where
    T: Send,

Create a BindTakeMut binder, which gives &'static mut T to a bound function.

pub const fn as_ref(&self) -> BindRef<System, T>where
    T: Sync,

Construct a BindRef, which can be used to get &'static T from a BindTable<System>.

BindRef doubles as a binder that gives &'static T in a bound executable object.

The configuration system can’t track the usages of BindRef (note the lack of a lifetime parameter in its definition). As such, merely calling this method counts as a use of the binding whether the returned BindRef is actually used or not.

impl<'pool, System, T> Bind<'pool, System, T>

Miscellaneous Methods

pub const fn hunk(&self) -> Hunk<System, BindData<T>>

Get the raw Hunk providing the backing store for this binding.

The referent type of the returned Hunk is an opaque type that has the same representation as T (because of #[repr(transparent)]). You can use Hunk::transmute to reinterpret it as you see fit.

Calling this method alone does not extend the binding’s lifetime nor prevent conflicting borrows from occurring. A dummy binding can be used to express the manner in which the raw hunk is used outside the configuration system’s knowledge. For example, if the raw hunk is going to be mutably borrowed, the caller of this method should create a dummy unpure binding that consumes the binding by take_mut.

Trait Implementations

impl<System, T> Clone for Bind<'_, System, T>

const fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'pool, const LEN: usize, System, T> UnzipBind for Bind<'pool, System, [T; LEN]>

type Target = [Bind<'pool, System, T>; LEN]

const fn unzip(self) -> Self::Target

Destruct Bind into individual bindings.

impl<'pool, System> UnzipBind for Bind<'pool, System, ()>

type Target = ()

const fn unzip(self) -> Self::Target

Destruct Bind into individual bindings.

impl<'pool, System, Field0, Field1, Field2, Field3, Field4, Field5, Field6, Field7, Field8, Field9, Field10, Field11, Field12, Field13, Field14> UnzipBind for Bind<'pool, System, (Field0, Field1, Field2, Field3, Field4, Field5, Field6, Field7, Field8, Field9, Field10, Field11, Field12, Field13, Field14)>

type Target = (Bind<'pool, System, Field0>, Bind<'pool, System, Field1>, Bind<'pool, System, Field2>, Bind<'pool, System, Field3>, Bind<'pool, System, Field4>, Bind<'pool, System, Field5>, Bind<'pool, System, Field6>, Bind<'pool, System, Field7>, Bind<'pool, System, Field8>, Bind<'pool, System, Field9>, Bind<'pool, System, Field10>, Bind<'pool, System, Field11>, Bind<'pool, System, Field12>, Bind<'pool, System, Field13>, Bind<'pool, System, Field14>)

const fn unzip(self) -> Self::Target

Destruct Bind into individual bindings.

impl<'pool, System, Field0, Field1, Field2, Field3, Field4, Field5, Field6, Field7, Field8, Field9, Field10, Field11, Field12, Field13> UnzipBind for Bind<'pool, System, (Field0, Field1, Field2, Field3, Field4, Field5, Field6, Field7, Field8, Field9, Field10, Field11, Field12, Field13)>

type Target = (Bind<'pool, System, Field0>, Bind<'pool, System, Field1>, Bind<'pool, System, Field2>, Bind<'pool, System, Field3>, Bind<'pool, System, Field4>, Bind<'pool, System, Field5>, Bind<'pool, System, Field6>, Bind<'pool, System, Field7>, Bind<'pool, System, Field8>, Bind<'pool, System, Field9>, Bind<'pool, System, Field10>, Bind<'pool, System, Field11>, Bind<'pool, System, Field12>, Bind<'pool, System, Field13>)

const fn unzip(self) -> Self::Target

Destruct Bind into individual bindings.

impl<'pool, System, Field0, Field1, Field2, Field3, Field4, Field5, Field6, Field7, Field8, Field9, Field10, Field11, Field12> UnzipBind for Bind<'pool, System, (Field0, Field1, Field2, Field3, Field4, Field5, Field6, Field7, Field8, Field9, Field10, Field11, Field12)>

type Target = (Bind<'pool, System, Field0>, Bind<'pool, System, Field1>, Bind<'pool, System, Field2>, Bind<'pool, System, Field3>, Bind<'pool, System, Field4>, Bind<'pool, System, Field5>, Bind<'pool, System, Field6>, Bind<'pool, System, Field7>, Bind<'pool, System, Field8>, Bind<'pool, System, Field9>, Bind<'pool, System, Field10>, Bind<'pool, System, Field11>, Bind<'pool, System, Field12>)

const fn unzip(self) -> Self::Target

Destruct Bind into individual bindings.

impl<'pool, System, Field0, Field1, Field2, Field3, Field4, Field5, Field6, Field7, Field8, Field9, Field10, Field11> UnzipBind for Bind<'pool, System, (Field0, Field1, Field2, Field3, Field4, Field5, Field6, Field7, Field8, Field9, Field10, Field11)>

type Target = (Bind<'pool, System, Field0>, Bind<'pool, System, Field1>, Bind<'pool, System, Field2>, Bind<'pool, System, Field3>, Bind<'pool, System, Field4>, Bind<'pool, System, Field5>, Bind<'pool, System, Field6>, Bind<'pool, System, Field7>, Bind<'pool, System, Field8>, Bind<'pool, System, Field9>, Bind<'pool, System, Field10>, Bind<'pool, System, Field11>)

const fn unzip(self) -> Self::Target

Destruct Bind into individual bindings.

impl<'pool, System, Field0, Field1, Field2, Field3, Field4, Field5, Field6, Field7, Field8, Field9, Field10> UnzipBind for Bind<'pool, System, (Field0, Field1, Field2, Field3, Field4, Field5, Field6, Field7, Field8, Field9, Field10)>

type Target = (Bind<'pool, System, Field0>, Bind<'pool, System, Field1>, Bind<'pool, System, Field2>, Bind<'pool, System, Field3>, Bind<'pool, System, Field4>, Bind<'pool, System, Field5>, Bind<'pool, System, Field6>, Bind<'pool, System, Field7>, Bind<'pool, System, Field8>, Bind<'pool, System, Field9>, Bind<'pool, System, Field10>)

const fn unzip(self) -> Self::Target

Destruct Bind into individual bindings.

impl<'pool, System, Field0, Field1, Field2, Field3, Field4, Field5, Field6, Field7, Field8, Field9> UnzipBind for Bind<'pool, System, (Field0, Field1, Field2, Field3, Field4, Field5, Field6, Field7, Field8, Field9)>

type Target = (Bind<'pool, System, Field0>, Bind<'pool, System, Field1>, Bind<'pool, System, Field2>, Bind<'pool, System, Field3>, Bind<'pool, System, Field4>, Bind<'pool, System, Field5>, Bind<'pool, System, Field6>, Bind<'pool, System, Field7>, Bind<'pool, System, Field8>, Bind<'pool, System, Field9>)

const fn unzip(self) -> Self::Target

Destruct Bind into individual bindings.

impl<'pool, System, Field0, Field1, Field2, Field3, Field4, Field5, Field6, Field7, Field8> UnzipBind for Bind<'pool, System, (Field0, Field1, Field2, Field3, Field4, Field5, Field6, Field7, Field8)>

type Target = (Bind<'pool, System, Field0>, Bind<'pool, System, Field1>, Bind<'pool, System, Field2>, Bind<'pool, System, Field3>, Bind<'pool, System, Field4>, Bind<'pool, System, Field5>, Bind<'pool, System, Field6>, Bind<'pool, System, Field7>, Bind<'pool, System, Field8>)

const fn unzip(self) -> Self::Target

Destruct Bind into individual bindings.

impl<'pool, System, Field0, Field1, Field2, Field3, Field4, Field5, Field6, Field7> UnzipBind for Bind<'pool, System, (Field0, Field1, Field2, Field3, Field4, Field5, Field6, Field7)>

type Target = (Bind<'pool, System, Field0>, Bind<'pool, System, Field1>, Bind<'pool, System, Field2>, Bind<'pool, System, Field3>, Bind<'pool, System, Field4>, Bind<'pool, System, Field5>, Bind<'pool, System, Field6>, Bind<'pool, System, Field7>)

const fn unzip(self) -> Self::Target

Destruct Bind into individual bindings.

impl<'pool, System, Field0, Field1, Field2, Field3, Field4, Field5, Field6> UnzipBind for Bind<'pool, System, (Field0, Field1, Field2, Field3, Field4, Field5, Field6)>

type Target = (Bind<'pool, System, Field0>, Bind<'pool, System, Field1>, Bind<'pool, System, Field2>, Bind<'pool, System, Field3>, Bind<'pool, System, Field4>, Bind<'pool, System, Field5>, Bind<'pool, System, Field6>)

const fn unzip(self) -> Self::Target

Destruct Bind into individual bindings.

impl<'pool, System, Field0, Field1, Field2, Field3, Field4, Field5> UnzipBind for Bind<'pool, System, (Field0, Field1, Field2, Field3, Field4, Field5)>

type Target = (Bind<'pool, System, Field0>, Bind<'pool, System, Field1>, Bind<'pool, System, Field2>, Bind<'pool, System, Field3>, Bind<'pool, System, Field4>, Bind<'pool, System, Field5>)

const fn unzip(self) -> Self::Target

Destruct Bind into individual bindings.

impl<'pool, System, Field0, Field1, Field2, Field3, Field4> UnzipBind for Bind<'pool, System, (Field0, Field1, Field2, Field3, Field4)>

type Target = (Bind<'pool, System, Field0>, Bind<'pool, System, Field1>, Bind<'pool, System, Field2>, Bind<'pool, System, Field3>, Bind<'pool, System, Field4>)

const fn unzip(self) -> Self::Target

Destruct Bind into individual bindings.

impl<'pool, System, Field0, Field1, Field2, Field3> UnzipBind for Bind<'pool, System, (Field0, Field1, Field2, Field3)>

type Target = (Bind<'pool, System, Field0>, Bind<'pool, System, Field1>, Bind<'pool, System, Field2>, Bind<'pool, System, Field3>)

const fn unzip(self) -> Self::Target

Destruct Bind into individual bindings.

impl<'pool, System, Field0, Field1, Field2> UnzipBind for Bind<'pool, System, (Field0, Field1, Field2)>

type Target = (Bind<'pool, System, Field0>, Bind<'pool, System, Field1>, Bind<'pool, System, Field2>)

const fn unzip(self) -> Self::Target

Destruct Bind into individual bindings.

impl<'pool, System, Field0, Field1> UnzipBind for Bind<'pool, System, (Field0, Field1)>

type Target = (Bind<'pool, System, Field0>, Bind<'pool, System, Field1>)

const fn unzip(self) -> Self::Target

Destruct Bind into individual bindings.

impl<'pool, System, Field0> UnzipBind for Bind<'pool, System, (Field0,)>

type Target = (Bind<'pool, System, Field0>,)

const fn unzip(self) -> Self::Target

Destruct Bind into individual bindings.

impl<System, T> Copy for Bind<'_, System, T>