Router

Struct Router 

Source
pub struct Router { /* private fields */ }
Expand description

Router is a service that nests other services on chosen routes

For example:

let mut router = Router::new();
router.add("/hello", DefaultService);

This will show the hello message on this route, and fire a 404 on others.

Routes can be of two types:

  • exact (does not end with /)
  • nested (ends with /)

Exact route is a hashmap match, nested route matches anything under chosen route.

Nested route example:

router.add("/files/", FilesService::new("files"));

This code will host all files in the “files” dir, under route /files/. Note that it also matches just /files, and that nested routes strip their prefix - so /files/something becomes /something in the route argument. Original route is still accessible via req.route

Nested routes are implemented with a linear search, consider something more optimized if you have thousands of them

§Errors

When a route cannot be matched, Router fires a StatusCode(404)

Implementations§

Source§

impl Router

Source

pub fn new() -> Router

Creates an empty Router

Source

pub fn add(&mut self, route: &str, service: impl HttpServiceRaw) -> &mut Self

Adds a new route

Trait Implementations§

Source§

impl Default for Router

Source§

fn default() -> Router

Returns the “default value” for a type. Read more
Source§

impl HttpService for Router

Source§

async fn request( &self, route: &str, req: &HttpRequest, body: &mut dyn HttpRead, ) -> HttpResult

Serve the request Read more
Source§

fn filter(&self, route: &str, req: &HttpRequest) -> HttpResult<()>

Checks if request is valid Read more

Auto Trait Implementations§

§

impl Freeze for Router

§

impl !RefUnwindSafe for Router

§

impl Send for Router

§

impl Sync for Router

§

impl Unpin for Router

§

impl !UnwindSafe for Router

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> HttpServiceRaw for T
where T: HttpService,

Source§

fn request_raw<'a>( &'a self, route: &'a str, req: &'a HttpRequest, body: &'a mut dyn HttpRead, ) -> Pin<Box<dyn Future<Output = Result<HttpResponse, Box<dyn HttpError>>> + Send + 'a>>

Serve the request (dyn version)
Source§

fn filter_raw( &self, route: &str, req: &HttpRequest, ) -> Result<(), Box<dyn HttpError>>

Checks if request is valid (dyn version)
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.