Struct axum_extra::routing::Resource

pub struct Resource<B = Body> { /* private fields */ }

A resource which defines a set of conventional CRUD routes.

Example

use axum::{Router, routing::get, extract::Path};
use axum_extra::routing::{RouterExt, Resource};

let users = Resource::named("users")
    // Define a route for `GET /users`
    .index(|| async {})
    // `POST /users`
    .create(|| async {})
    // `GET /users/new`
    .new(|| async {})
    // `GET /users/:users_id`
    .show(|Path(user_id): Path<u64>| async {})
    // `GET /users/:users_id/edit`
    .edit(|Path(user_id): Path<u64>| async {})
    // `PUT or PATCH /users/:users_id`
    .update(|Path(user_id): Path<u64>| async {})
    // `DELETE /users/:users_id`
    .destroy(|Path(user_id): Path<u64>| async {})
    // Nest another router at the "member level"
    // This defines a route for `GET /users/:users_id/tweets`
    .nest(Router::new().route(
        "/tweets",
        get(|Path(user_id): Path<u64>| async {}),
    ))
    // Nest another router at the "collection level"
    // This defines a route for `GET /users/featured`
    .nest_collection(
        Router::new().route("/featured", get(|| async {})),
    );

let app = Router::new().merge(users);

Implementations

impl<B> Resource<B> where
    B: HttpBody + Send + 'static, 

pub fn named(resource_name: &str) -> Self

Create a Resource with the given name.

All routes will be nested at /{resource_name}.

pub fn index<H, T>(self, handler: H) -> Self where
    H: Handler<T, B>,
    T: 'static, 

Add a handler at GET /{resource_name}.

pub fn create<H, T>(self, handler: H) -> Self where
    H: Handler<T, B>,
    T: 'static, 

Add a handler at POST /{resource_name}.

pub fn new<H, T>(self, handler: H) -> Self where
    H: Handler<T, B>,
    T: 'static, 

Add a handler at GET /{resource_name}/new.

pub fn show<H, T>(self, handler: H) -> Self where
    H: Handler<T, B>,
    T: 'static, 

Add a handler at GET /{resource_name}/:{resource_name}_id.

pub fn edit<H, T>(self, handler: H) -> Self where
    H: Handler<T, B>,
    T: 'static, 

Add a handler at GET /{resource_name}/:{resource_name}_id/edit.

pub fn update<H, T>(self, handler: H) -> Self where
    H: Handler<T, B>,
    T: 'static, 

Add a handler at PUT or PATCH /resource_name/:{resource_name}_id.

pub fn destroy<H, T>(self, handler: H) -> Self where
    H: Handler<T, B>,
    T: 'static, 

Add a handler at DELETE /{resource_name}/:{resource_name}_id.

pub fn nest<T>(self, svc: T) -> Self where
    T: Service<Request<B>, Response = Response, Error = Infallible> + Clone + Send + 'static,
    T::Future: Send + 'static, 

Nest another route at the “member level”.

The routes will be nested at /{resource_name}/:{resource_name}_id.

pub fn nest_collection<T>(self, svc: T) -> Self where
    T: Service<Request<B>, Response = Response, Error = Infallible> + Clone + Send + 'static,
    T::Future: Send + 'static, 

Nest another route at the “collection level”.

The routes will be nested at /{resource_name}.

Trait Implementations

impl<B: Debug> Debug for Resource<B>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<B> From<Resource<B>> for Router<B>

fn from(resource: Resource<B>) -> Self

Converts to this type from the input type.