Skip to main content

App

rskit

Struct App 

Source 
pub struct App<S, C> { /* private fields */ }
Expand description

Application orchestrator with typestate lifecycle.

Valid transitions are compile-time scoped:

AppBuilder::build() -> App<Built, C>
App<Built, C>::start() -> App<Started, C>
App<Started, C>::stop() -> App<Stopped, C>

Implementations§

Source§

impl<C> App<Built, C>
where C: AppConfig,

Source

pub fn builder(config: C) -> AppBuilder<C>

Create an AppBuilder.

Source§

impl<C> App<Built, C>

Source

pub fn config(&self) -> Arc<C>

Return a clone of the shared application configuration.

Source

pub fn container(&self) -> Arc<Container>

Return the typed application DI container.

Source

pub fn lifecycle_event_bus(&self) -> EventBus<LifecycleEvent>

Return the bounded lifecycle event bus used by this app.

Source

pub fn shutdown_token(&self) -> CancellationToken

Clone the shutdown token to share with long-running tasks.

Source

pub fn before_start<F, Fut>(self, hook: F) -> App<Built, C>
where F: Fn(CancellationToken) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), AppError>> + Send + 'static,

Register a hook called before components start.

Source

pub fn after_start<F, Fut>(self, hook: F) -> App<Built, C>
where F: Fn(CancellationToken) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), AppError>> + Send + 'static,

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

Source

pub fn before_stop<F, Fut>(self, hook: F) -> App<Built, C>
where F: Fn(CancellationToken) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), AppError>> + Send + 'static,

Register a hook called before components stop.

Source

pub fn after_stop<F, Fut>(self, hook: F) -> App<Built, C>
where F: Fn(CancellationToken) -> Fut + Send + Sync + 'static, Fut: Future<Output = Result<(), AppError>> + Send + 'static,

Register a hook called after components stop.

Source§

impl<C> App<Built, C>
where C: AppConfig,

Source

pub async fn start(self) -> Result<App<Started, C>, AppError>

Start components and transition to Started.

Source

pub async fn run(self) -> Result<(), AppError>

Run as a long-running service until a signal or shutdown token fires.

Source

pub async fn run_task<F, Fut>(self, task: F) -> Result<(), AppError>
where F: FnOnce(Arc<C>, CancellationToken) -> Fut, Fut: Future<Output = Result<(), AppError>>,

Run a finite task after startup, then stop the app.

Source§

impl<C> App<Started, C>

Source

pub fn config(&self) -> Arc<C>

Return a clone of the shared application configuration.

Source

pub fn container(&self) -> Arc<Container>

Return the typed application DI container.

Source

pub fn lifecycle_event_bus(&self) -> EventBus<LifecycleEvent>

Return the bounded lifecycle event bus used by this app.

Source

pub fn shutdown_token(&self) -> CancellationToken

Clone the shutdown token to share with long-running tasks.

Source

pub async fn stop(self) -> Result<App<Stopped, C>, AppError>

Stop components and transition to Stopped.

Source§

impl<C> App<Stopped, C>

Source

pub fn config(&self) -> Arc<C>

Return a clone of the shared application configuration.

Source

pub fn lifecycle_event_bus(&self) -> EventBus<LifecycleEvent>

Return the bounded lifecycle event bus used by this app.

Auto Trait Implementations§

§

impl<S, C> !RefUnwindSafe for App<S, C>

§

impl<S, C> !UnwindSafe for App<S, C>

§

impl<S, C> Freeze for App<S, C>

§

impl<S, C> Send for App<S, C>
where S: Send, C: Sync + Send,

§

impl<S, C> Sync for App<S, C>
where S: Sync, C: Sync + Send,

§

impl<S, C> Unpin for App<S, C>
where S: Unpin,

§

impl<S, C> UnsafeUnpin for App<S, C>

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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CompatExt for T

Source§

fn compat(self) -> Compat<T>
where T: Sized,

Applies the Compat adapter by value. Read more
Source§

fn compat_ref(&self) -> Compat<&T>

Applies the Compat adapter by shared reference. Read more
Source§

fn compat_mut(&mut self) -> Compat<&mut T>

Applies the Compat adapter by mutable reference. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FutureExt for T

Source§

fn with_context(self, otel_cx: Context) -> WithContext<Self>

Attaches the provided Context to this type, returning a WithContext wrapper. Read more
Source§

fn with_current_context(self) -> WithContext<Self>

Attaches the current Context to this type, returning a WithContext wrapper. Read more
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> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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
Source§

impl<T> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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