Struct HttpService 

pub struct HttpService { /* private fields */ }

Implementations

impl HttpService

pub fn builder<S>(path_root: Option<&str>, state: &S) -> HttpServiceBuilder<S>

where S: Clone + Send + Sync + 'static, AppContext: FromRef<S>,

Create a new HttpServiceBuilder.

pub fn router(&self) -> &Router

pub fn list_routes(&self) -> Vec<(&str, &str)>

List the available HTTP API routes.

Note that in order for a route to show up where, it needs to be registered with an aide::axum::ApiRouter and provided when building the HttpService.

pub fn print_open_api_schema(&self, options: &OpenApiArgs) -> RoadsterResult<()>

Generate an OpenAPI schema for the HTTP API and either print to stdout or to the path provided in OpenApiArgs.

pub fn open_api_schema(&self, options: &OpenApiArgs) -> RoadsterResult<String>

Generate an OpenAPI schema for the HTTP API and either return it as a JSON string.

Note: This method ignores the output field of OpenApiArgs.

pub fn open_api(&self) -> Arc<OpenApi>

Get the OpenApi for this HttpService. Useful to implement custom processing of the schema that isn’t provided by Roadster.

Trait Implementations

impl<S> Service<S> for HttpService

where S: Clone + Send + Sync + 'static, AppContext: FromRef<S>,

fn name(&self) -> String

The name of the service.

fn enabled(&self, state: &S) -> bool

Whether the service is enabled. If the service is not enabled, it will not be run.

fn run<'life0, 'async_trait>( self: Box<Self>, state: &'life0 S, cancel_token: CancellationToken, ) -> Pin<Box<dyn Future<Output = RoadsterResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Run the service in a new tokio task.

fn before_run<'life0, 'life1, 'async_trait>( &'life0 self, _state: &'life1 S, ) -> Pin<Box<dyn Future<Output = RoadsterResult<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Perform any initialization work or other checks that should be done before the service runs.

impl<S> ServiceBuilder<S, HttpService> for HttpServiceBuilder<S>

where S: Clone + Send + Sync + 'static, AppContext: FromRef<S>,

fn name(&self) -> String

fn enabled(&self, state: &S) -> bool

fn build<'life0, 'async_trait>( self, state: &'life0 S, ) -> Pin<Box<dyn Future<Output = RoadsterResult<HttpService>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,