Struct axum_extra::routing::Resource

source ·
pub struct Resource<S = ()> { /* private fields */ }
Expand description

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§

source§

impl<S> Resource<S>
where S: Clone + Send + Sync + 'static,

source

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

Create a Resource with the given name.

All routes will be nested at /{resource_name}.

source

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

Add a handler at GET /{resource_name}.

source

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

Add a handler at POST /{resource_name}.

source

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

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

source

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.

source

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.

source

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.

source

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§

source§

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

source§

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

Formats the value using the given formatter. Read more
source§

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

source§

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

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<S> Freeze for Resource<S>

§

impl<S = ()> !RefUnwindSafe for Resource<S>

§

impl<S> Send for Resource<S>

§

impl<S> Sync for Resource<S>

§

impl<S> Unpin for Resource<S>

§

impl<S = ()> !UnwindSafe for Resource<S>

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more