RequiredComponentsRegistrator

Struct RequiredComponentsRegistrator 

Source
pub struct RequiredComponentsRegistrator<'a, 'w> { /* private fields */ }
Expand description

This is a safe handle around ComponentsRegistrator and RequiredComponents to register required components.

Implementations§

Source§

impl<'a, 'w> RequiredComponentsRegistrator<'a, 'w>

Source

pub fn register_required<C: Component>(&mut self, constructor: fn() -> C)

Registers the Component C as an explicitly required component.

If the component was not already registered as an explicit required component then it is added as one, potentially overriding the constructor of a inherited required component, otherwise panics.

Source

pub unsafe fn register_required_by_id<C: Component>( &mut self, component_id: ComponentId, constructor: fn() -> C, )

Registers the Component with the given component_id ID as an explicitly required component.

If the component was not already registered as an explicit required component then it is added as one, potentially overriding the constructor of a inherited required component, otherwise panics.

§Safety

component_id must be a valid ComponentId for C in the Components instance of self.

Source

pub unsafe fn register_required_dynamic_with( &mut self, component_id: ComponentId, constructor: impl FnOnce() -> RequiredComponentConstructor, )

Registers the Component with the given component_id ID as an explicitly required component.

If the component was not already registered as an explicit required component then it is added as one, potentially overriding the constructor of a inherited required component, otherwise panics.

§Safety
  • component_id must be valid in the Components instance of self;
  • constructor must return a RequiredComponentConstructor that constructs a valid instance for the component with ID component_id.

Auto Trait Implementations§

§

impl<'a, 'w> Freeze for RequiredComponentsRegistrator<'a, 'w>

§

impl<'a, 'w> !RefUnwindSafe for RequiredComponentsRegistrator<'a, 'w>

§

impl<'a, 'w> !Send for RequiredComponentsRegistrator<'a, 'w>

§

impl<'a, 'w> !Sync for RequiredComponentsRegistrator<'a, 'w>

§

impl<'a, 'w> Unpin for RequiredComponentsRegistrator<'a, 'w>

§

impl<'a, 'w> !UnwindSafe for RequiredComponentsRegistrator<'a, 'w>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoResult<T> for T

Source§

fn into_result(self) -> Result<T, RunSystemError>

Converts this type into the system output type.
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.