Enum StartupHook 

pub enum StartupHook {
    Sync(Box<dyn FnOnce() -> Result<(), StartupHookError> + Send>),
    AsyncFactory(Box<dyn FnOnce() -> Pin<Box<dyn Future<Output = Result<(), StartupHookError>> + Send>> + Send>),
}

A startup hook that runs before the server starts accepting connections.

Variants

Sync(Box<dyn FnOnce() -> Result<(), StartupHookError> + Send>)

Synchronous startup function.

AsyncFactory(Box<dyn FnOnce() -> Pin<Box<dyn Future<Output = Result<(), StartupHookError>> + Send>> + Send>)

Factory for async startup future.

Implementations

impl StartupHook

pub fn sync<F>(f: F) -> Self

where F: FnOnce() -> Result<(), StartupHookError> + Send + 'static,

Create a synchronous startup hook.

pub fn async_fn<F, Fut>(f: F) -> Self

where F: FnOnce() -> Fut + Send + 'static, Fut: Future<Output = Result<(), StartupHookError>> + Send + 'static,

Create an async startup hook.

pub fn run( self, ) -> Result<Option<Pin<Box<dyn Future<Output = Result<(), StartupHookError>> + Send>>>, StartupHookError>

Run the hook synchronously.

For async hooks, this returns the future to await.