pub struct EngineBuilder { /* private fields */ }Expand description
Builder for constructing an Engine with plugins.
§Example
use astrelis::{EngineBuilder, FnPlugin};
let engine = EngineBuilder::new()
.add_plugin(FnPlugin::new("config", |resources| {
resources.insert("game_title".to_string());
}))
.build();Implementations§
Source§impl EngineBuilder
impl EngineBuilder
Sourcepub fn add_plugin(self, plugin: impl Plugin + 'static) -> Self
pub fn add_plugin(self, plugin: impl Plugin + 'static) -> Self
Add a plugin to the engine.
Plugins are built in the order they are added, with dependency ordering handled automatically.
Sourcepub fn add_plugins(self, group: impl PluginGroup) -> Self
pub fn add_plugins(self, group: impl PluginGroup) -> Self
Add a plugin group (multiple plugins) to the engine.
Sourcepub fn insert_resource<R: Resource>(self, resource: R) -> Self
pub fn insert_resource<R: Resource>(self, resource: R) -> Self
Insert a resource directly before building.
This is useful for resources that plugins might depend on but that aren’t provided by a plugin.
Sourcepub fn try_build(self) -> Result<Engine, EngineError>
pub fn try_build(self) -> Result<Engine, EngineError>
Build the engine, initializing all plugins.
This will:
- Sort plugins by dependencies
- Call
build()on each plugin - Call
finish()on each plugin
§Errors
Returns EngineError if:
- A circular dependency is detected between plugins
- A plugin dependency is not found
- A plugin with the same name is added twice
Sourcepub fn build(self) -> Engine
pub fn build(self) -> Engine
Build the engine, panicking on error.
This is a convenience method for examples and tests where error handling
is not needed. For production code, prefer try_build() which returns
a Result.
§Panics
Panics if:
- A circular dependency is detected between plugins
- A plugin dependency is not found
- A plugin with the same name is added twice
Trait Implementations§
Auto Trait Implementations§
impl Freeze for EngineBuilder
impl !RefUnwindSafe for EngineBuilder
impl Send for EngineBuilder
impl Sync for EngineBuilder
impl Unpin for EngineBuilder
impl UnsafeUnpin for EngineBuilder
impl !UnwindSafe for EngineBuilder
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> Downcast for Twhere
T: Any,
impl<T> Downcast for Twhere
T: Any,
Source§fn into_any(self: Box<T>) -> Box<dyn Any>
fn into_any(self: Box<T>) -> Box<dyn Any>
Convert
Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can
then be further downcast into Box<ConcreteType> where ConcreteType implements Trait.Source§fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
fn into_any_rc(self: Rc<T>) -> Rc<dyn Any>
Convert
Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be
further downcast into Rc<ConcreteType> where ConcreteType implements Trait.Source§fn as_any(&self) -> &(dyn Any + 'static)
fn as_any(&self) -> &(dyn Any + 'static)
Convert
&Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &Any’s vtable from &Trait’s.Source§fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
Convert
&mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot
generate &mut Any’s vtable from &mut Trait’s.Source§impl<T> DowncastSync for T
impl<T> DowncastSync for T
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left is true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
Converts
self into a Left variant of Either<Self, Self>
if into_left(&self) returns true.
Converts self into a Right variant of Either<Self, Self>
otherwise. Read more