Struct Witchcraft

pub struct Witchcraft { /* private fields */ }

The Witchcraft server context.

Implementations

impl Witchcraft

pub fn metrics(&self) -> &Arc<MetricRegistry>

Returns a reference to the server’s metric registry.

pub fn health_checks(&self) -> &Arc<HealthCheckRegistry>

Returns a reference to the server’s health check registry.

pub fn readiness_checks(&self) -> &Arc<ReadinessCheckRegistry>

Returns a reference to the server’s readiness check registry.

pub fn client_factory(&self) -> &ClientFactory

Returns a reference to the server’s HTTP client factory.

pub fn diagnostics(&self) -> &Arc<DiagnosticRegistry>

Returns a reference to the server’s diagnostics registry.

pub fn handle(&self) -> &Handle

Returns a reference to a handle to the server’s Tokio runtime.

pub fn app<T>(&mut self, service: T)

where T: AsyncService<RequestBody, ResponseWriter>,

Installs an async service at the server’s root.

pub fn api<T>(&mut self, service: T)

where T: AsyncService<RequestBody, ResponseWriter>,

Installs an async service under the server’s /api prefix.

pub fn blocking_app<T>(&mut self, service: T)

where T: Service<RequestBody, ResponseWriter>,

Installs a blocking service at the server’s root.

pub fn blocking_api<T>(&mut self, service: T)

where T: Service<RequestBody, ResponseWriter>,

Installs a blocking service under the server’s /api prefix.

pub fn on_shutdown<F>(&mut self, future: F)

where F: Future<Output = ()> + 'static + Send,

Adds a future that will be run when the server begins its shutdown process.

The server will not shut down until the future completes or the configured shutdown timeout elapses.