Route

Struct Route 

Source
pub struct Route<'a> { /* private fields */ }
Expand description

A handle to a route.

All HTTP requests are made against resources. After using Server::at (or Route::at) to establish a route, the Route type can be used to establish endpoints for various HTTP methods at that path. Also, using nest, it can be used to set up a subrouter.

Implementations§

Source§

impl<'a> Route<'a>

Source

pub fn at<'b>(&'b mut self, path: &str) -> Route<'b>

Extend the route with the given path.

Source

pub fn path(&self) -> &str

Get the current path.

Source

pub fn with(&mut self, middleware: impl Middleware + 'static) -> &mut Self

Apply the given middleware to the current route.

Source

pub fn reset_middleware(&mut self) -> &mut Self

Reset the middleware chain for the current route, if any.

Source

pub fn nest(&mut self, service: Server) -> &mut Self

Nest a [Server] at the current path.

§Note

The outer server always has precedence when disambiguating overlapping paths. For example in the following example /hello will return “Unexpected” to the client [Server]: struct.Server.html

Source

pub fn method( &mut self, method: Method, ep: impl Endpoint + 'static, ) -> &mut Self

Add an endpoint for the given HTTP method

Source

pub fn all(&mut self, ep: impl Endpoint + 'static) -> &mut Self

Add an endpoint for all HTTP methods, as a fallback.

Routes with specific HTTP methods will be tried first.

Source

pub fn get(&mut self, ep: impl Endpoint + 'static) -> &mut Self

Add an endpoint for GET requests

Source

pub fn head(&mut self, ep: impl Endpoint + 'static) -> &mut Self

Add an endpoint for HEAD requests

Source

pub fn put(&mut self, ep: impl Endpoint + 'static) -> &mut Self

Add an endpoint for PUT requests

Source

pub fn post(&mut self, ep: impl Endpoint + 'static) -> &mut Self

Add an endpoint for POST requests

Source

pub fn delete(&mut self, ep: impl Endpoint + 'static) -> &mut Self

Add an endpoint for DELETE requests

Source

pub fn options(&mut self, ep: impl Endpoint + 'static) -> &mut Self

Add an endpoint for OPTIONS requests

Source

pub fn connect(&mut self, ep: impl Endpoint + 'static) -> &mut Self

Add an endpoint for CONNECT requests

Source

pub fn patch(&mut self, ep: impl Endpoint + 'static) -> &mut Self

Add an endpoint for PATCH requests

Source

pub fn trace(&mut self, ep: impl Endpoint + 'static) -> &mut Self

Add an endpoint for TRACE requests

Auto Trait Implementations§

§

impl<'a> Freeze for Route<'a>

§

impl<'a> !RefUnwindSafe for Route<'a>

§

impl<'a> Send for Route<'a>

§

impl<'a> Sync for Route<'a>

§

impl<'a> Unpin for Route<'a>

§

impl<'a> !UnwindSafe for Route<'a>

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, U> TryFrom<U> for T
where U: Into<T>,

Source§

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>,

Source§

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<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