Struct Resource

pub struct Resource<S = ()> { /* 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 {});

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

Implementations

impl<S> Resource<S>

where S: Clone + Send + Sync + '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, S>, T: 'static,

Add a handler at GET /{resource_name}.

pub fn create<H, T>(self, handler: H) -> Self

where H: Handler<T, S>, T: 'static,

Add a handler at POST /{resource_name}.

pub fn new<H, T>(self, handler: H) -> Self

where H: Handler<T, S>, T: 'static,

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

pub fn show<H, T>(self, handler: H) -> Self

where H: Handler<T, S>, 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, S>, 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, S>, 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, S>, T: 'static,

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

Trait Implementations

impl<S: Debug> Debug for Resource<S>

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

Formats the value using the given formatter.

impl<S> From<Resource<S>> for Router<S>

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

Converts to this type from the input type.