Struct aide::axum::routing::ApiMethodRouter

pub struct ApiMethodRouter<S = (), E = Infallible> { /* private fields */ }

Available on crate feature axum only.

A wrapper over axum::routing::MethodRouter that adds API documentation-specific features.

Implementations

impl<S> ApiMethodRouter<S, Infallible>

where S: Clone + Send + Sync + 'static,

pub fn delete<H, I, O, T>(self, handler: H) -> Self

where H: Handler<T, S> + OperationHandler<I, O>, I: OperationInput, O: OperationOutput, T: 'static,

Route delete requests to the given handler. See axum::routing::MethodRouter::delete for more details.

pub fn delete_with<H, I, O, T, F>(self, handler: H, transform: F) -> Self

where H: Handler<T, S> + OperationHandler<I, O>, I: OperationInput, O: OperationOutput, T: 'static, F: FnOnce(TransformOperation<'_>) -> TransformOperation<'_>,

Route delete requests to the given handler. See axum::routing::MethodRouter::delete for more details.

This method additionally accepts a transform function, see crate::axum for more details.

pub fn get<H, I, O, T>(self, handler: H) -> Self

where H: Handler<T, S> + OperationHandler<I, O>, I: OperationInput, O: OperationOutput, T: 'static,

Route get requests to the given handler. See axum::routing::MethodRouter::get for more details.

pub fn get_with<H, I, O, T, F>(self, handler: H, transform: F) -> Self

where H: Handler<T, S> + OperationHandler<I, O>, I: OperationInput, O: OperationOutput, T: 'static, F: FnOnce(TransformOperation<'_>) -> TransformOperation<'_>,

Route get requests to the given handler. See axum::routing::MethodRouter::get for more details.

This method additionally accepts a transform function, see crate::axum for more details.

pub fn head<H, I, O, T>(self, handler: H) -> Self

where H: Handler<T, S> + OperationHandler<I, O>, I: OperationInput, O: OperationOutput, T: 'static,

Route head requests to the given handler. See axum::routing::MethodRouter::head for more details.

pub fn head_with<H, I, O, T, F>(self, handler: H, transform: F) -> Self

where H: Handler<T, S> + OperationHandler<I, O>, I: OperationInput, O: OperationOutput, T: 'static, F: FnOnce(TransformOperation<'_>) -> TransformOperation<'_>,

Route head requests to the given handler. See axum::routing::MethodRouter::head for more details.

This method additionally accepts a transform function, see crate::axum for more details.

pub fn options<H, I, O, T>(self, handler: H) -> Self

where H: Handler<T, S> + OperationHandler<I, O>, I: OperationInput, O: OperationOutput, T: 'static,

Route options requests to the given handler. See axum::routing::MethodRouter::options for more details.

pub fn options_with<H, I, O, T, F>(self, handler: H, transform: F) -> Self

where H: Handler<T, S> + OperationHandler<I, O>, I: OperationInput, O: OperationOutput, T: 'static, F: FnOnce(TransformOperation<'_>) -> TransformOperation<'_>,

Route options requests to the given handler. See axum::routing::MethodRouter::options for more details.

This method additionally accepts a transform function, see crate::axum for more details.

pub fn patch<H, I, O, T>(self, handler: H) -> Self

where H: Handler<T, S> + OperationHandler<I, O>, I: OperationInput, O: OperationOutput, T: 'static,

Route patch requests to the given handler. See axum::routing::MethodRouter::patch for more details.

pub fn patch_with<H, I, O, T, F>(self, handler: H, transform: F) -> Self

where H: Handler<T, S> + OperationHandler<I, O>, I: OperationInput, O: OperationOutput, T: 'static, F: FnOnce(TransformOperation<'_>) -> TransformOperation<'_>,

Route patch requests to the given handler. See axum::routing::MethodRouter::patch for more details.

This method additionally accepts a transform function, see crate::axum for more details.

pub fn post<H, I, O, T>(self, handler: H) -> Self

where H: Handler<T, S> + OperationHandler<I, O>, I: OperationInput, O: OperationOutput, T: 'static,

Route post requests to the given handler. See axum::routing::MethodRouter::post for more details.

pub fn post_with<H, I, O, T, F>(self, handler: H, transform: F) -> Self

where H: Handler<T, S> + OperationHandler<I, O>, I: OperationInput, O: OperationOutput, T: 'static, F: FnOnce(TransformOperation<'_>) -> TransformOperation<'_>,

Route post requests to the given handler. See axum::routing::MethodRouter::post for more details.

This method additionally accepts a transform function, see crate::axum for more details.

pub fn put<H, I, O, T>(self, handler: H) -> Self

where H: Handler<T, S> + OperationHandler<I, O>, I: OperationInput, O: OperationOutput, T: 'static,

Route put requests to the given handler. See axum::routing::MethodRouter::put for more details.

pub fn put_with<H, I, O, T, F>(self, handler: H, transform: F) -> Self

where H: Handler<T, S> + OperationHandler<I, O>, I: OperationInput, O: OperationOutput, T: 'static, F: FnOnce(TransformOperation<'_>) -> TransformOperation<'_>,

Route put requests to the given handler. See axum::routing::MethodRouter::put for more details.

This method additionally accepts a transform function, see crate::axum for more details.

pub fn trace<H, I, O, T>(self, handler: H) -> Self

where H: Handler<T, S> + OperationHandler<I, O>, I: OperationInput, O: OperationOutput, T: 'static,

Route trace requests to the given handler. See axum::routing::MethodRouter::trace for more details.

pub fn trace_with<H, I, O, T, F>(self, handler: H, transform: F) -> Self

where H: Handler<T, S> + OperationHandler<I, O>, I: OperationInput, O: OperationOutput, T: 'static, F: FnOnce(TransformOperation<'_>) -> TransformOperation<'_>,

Route trace requests to the given handler. See axum::routing::MethodRouter::trace for more details.

This method additionally accepts a transform function, see crate::axum for more details.

impl<S, E> ApiMethodRouter<S, E>

where S: Clone,

pub fn new() -> Self

Create a new, empty ApiMethodRouter based on MethodRouter::new().

pub fn merge<M>(self, other: M) -> Self

where M: Into<ApiMethodRouter<S, E>>,

See axum::routing::MethodRouter::merge.

pub fn layer<L, NewError>(self, layer: L) -> ApiMethodRouter<S, NewError>

where L: Layer<Route<E>> + Clone + Send + 'static, L::Service: Service<Request<Body>> + Clone + Send + 'static, <L::Service as Service<Request<Body>>>::Response: IntoResponse + 'static, <L::Service as Service<Request<Body>>>::Error: Into<NewError> + 'static, <L::Service as Service<Request<Body>>>::Future: Send + 'static, E: 'static, S: 'static, NewError: 'static,

See axum::routing::method_routing::MethodRouter::layer.

pub fn with_state<S2>(self, state: S) -> ApiMethodRouter<S2, E>

See axum::routing::method_routing::MethodRouter::with_state.

pub fn on_service<T>(self, filter: MethodFilter, svc: T) -> Self

where T: Service<Request<Body>, Error = E> + Clone + Send + 'static, T::Response: IntoResponse + 'static, T::Future: Send + 'static,

See axum::routing::method_routing::MethodRouter::on_service.

pub fn fallback_service<T>(self, svc: T) -> Self

where T: Service<Request<Body>, Error = E> + Clone + Send + 'static, T::Response: IntoResponse + 'static, T::Future: Send + 'static,

See axum::routing::method_routing::MethodRouter::fallback_service.

pub fn route_layer<L>(self, layer: L) -> ApiMethodRouter<S, E>

where L: Layer<Route<E>> + Clone + Send + 'static, L::Service: Service<Request<Body>, Error = E> + Clone + Send + 'static, <L::Service as Service<Request<Body>>>::Response: IntoResponse + 'static, <L::Service as Service<Request<Body>>>::Future: Send + 'static, E: 'static, S: 'static,

See axum::routing::method_routing::MethodRouter::route_layer.

Trait Implementations

impl<S, E> Clone for ApiMethodRouter<S, E>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<S, E> Default for ApiMethodRouter<S, E>

where S: Clone,

fn default() -> Self

Returns the “default value” for a type.

impl<S, E> From<ApiMethodRouter<S, E>> for MethodRouter<S, E>

fn from(router: ApiMethodRouter<S, E>) -> Self

Converts to this type from the input type.

impl<S, E> From<MethodRouter<S, E>> for ApiMethodRouter<S, E>

fn from(router: MethodRouter<S, E>) -> Self

Converts to this type from the input type.