Skip to main content

AppBuilder

Struct AppBuilder 

Source
pub struct AppBuilder<C: AppConfig> { /* private fields */ }
Expand description

Builder for App.

The builder is the composition root for configuration validation, component registration, dependency injection, provider registration, and lifecycle hook ordering.

Implementations§

Source§

impl<C: AppConfig> AppBuilder<C>

Source

pub fn new(config: C) -> Self

Create a new builder with the given application configuration.

Source

pub fn with_graceful_timeout(self, timeout: Duration) -> Self

Set the graceful shutdown timeout.

Source

pub fn with_component(self, component: Arc<dyn Component>) -> Self

Register a component to be started and stopped by the app lifecycle.

Source

pub fn with_container(self, container: Arc<Container>) -> Self

Use an existing typed DI container as the application container.

Source

pub fn with_lifecycle_event_bus( self, lifecycle_events: EventBus<LifecycleEvent>, ) -> Self

Use an existing bounded lifecycle event bus.

Source

pub fn with_dependency<T>(self, dependency: Arc<T>) -> Self
where T: Send + Sync + 'static,

Register a typed dependency in the application DI container.

Source

pub fn with_provider<P>(self, provider: Arc<P>) -> Self
where P: Provider + Send + Sync + 'static,

Register a provider implementation in the application DI container.

Source

pub fn before_start<F, Fut>(self, hook: F) -> Self
where F: Fn(CancellationToken) -> Fut + Send + Sync + 'static, Fut: Future<Output = AppResult<()>> + Send + 'static,

Register a hook called before components start.

Source

pub fn after_start<F, Fut>(self, hook: F) -> Self
where F: Fn(CancellationToken) -> Fut + Send + Sync + 'static, Fut: Future<Output = AppResult<()>> + Send + 'static,

Register a hook called after components start and readiness checks pass.

Source

pub fn before_stop<F, Fut>(self, hook: F) -> Self
where F: Fn(CancellationToken) -> Fut + Send + Sync + 'static, Fut: Future<Output = AppResult<()>> + Send + 'static,

Register a hook called before components stop.

Source

pub fn after_stop<F, Fut>(self, hook: F) -> Self
where F: Fn(CancellationToken) -> Fut + Send + Sync + 'static, Fut: Future<Output = AppResult<()>> + Send + 'static,

Register a hook called after components stop.

Source

pub fn build(self) -> AppResult<App<Built, C>>

Validate config and build the application in the Built state.

Auto Trait Implementations§

§

impl<C> !RefUnwindSafe for AppBuilder<C>

§

impl<C> !UnwindSafe for AppBuilder<C>

§

impl<C> Freeze for AppBuilder<C>
where C: Freeze,

§

impl<C> Send for AppBuilder<C>

§

impl<C> Sync for AppBuilder<C>

§

impl<C> Unpin for AppBuilder<C>
where C: Unpin,

§

impl<C> UnsafeUnpin for AppBuilder<C>
where C: UnsafeUnpin,

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> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more