Skip to main content

Route

Struct Route 

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

A route that can be used to route requests to their respective views.

Non-empty route paths may omit the leading slash. Cot normalizes them by prepending /, so "home" and "/home" define the same route.

§Examples

use cot::request::Request;
use cot::response::Response;
use cot::router::{Route, Router};

async fn home(request: Request) -> cot::Result<Response> {
    unimplemented!()
}

let router = Router::with_urls([Route::with_handler_and_name("/", home, "home")]);

Implementations§

Source§

impl Route

Source

pub fn with_handler<HandlerParams, H>(url: &str, handler: H) -> Self
where HandlerParams: 'static, H: RequestHandler<HandlerParams> + Send + Sync + 'static,

Create a new route with the given handler.

§Examples
use cot::request::Request;
use cot::response::Response;
use cot::router::{Route, Router};

async fn home(request: Request) -> cot::Result<Response> {
    // ...
}

let route = Route::with_handler("home", home);
assert_eq!(route.url(), "/home");
Source

pub fn with_api_handler<HandlerParams, H>(url: &str, handler: H) -> Self
where HandlerParams: 'static, H: RequestHandler<HandlerParams> + AsApiRoute + Send + Sync + 'static,

Available on crate feature openapi only.

Create a new route with the given handler for inclusion in the OpenAPI specifications.

See crate::openapi module documentation for more details on how to generate OpenAPI specifications automatically.

§Examples
use cot::request::Request;
use cot::response::Response;
use cot::router::method::openapi::api_get;
use cot::router::{Route, Router};

async fn home(request: Request) -> cot::Result<Response> {
    // ...
}

let route = Route::with_api_handler("/", api_get(home));
Source

pub fn with_handler_and_name<N, HandlerParams, H>( url: &str, handler: H, name: N, ) -> Self
where N: Into<String>, HandlerParams: 'static, H: RequestHandler<HandlerParams> + Send + Sync + 'static,

Create a new route with the given handler and name.

§Examples
use cot::request::Request;
use cot::response::Response;
use cot::router::method::openapi::api_get;
use cot::router::{Route, Router};

async fn home(request: Request) -> cot::Result<Response> {
    // ...
}

let route = Route::with_handler_and_name("/", api_get(home), "home");
Source

pub fn with_api_handler_and_name<N, HandlerParams, H>( url: &str, handler: H, name: N, ) -> Self
where N: Into<String>, HandlerParams: 'static, H: RequestHandler<HandlerParams> + AsApiRoute + Send + Sync + 'static,

Available on crate feature openapi only.

Create a new route with the given handler and name for inclusion in the OpenAPI specs.

See crate::openapi module documentation for more details on how to generate OpenAPI specs automatically.

§Examples
use cot::request::Request;
use cot::response::Response;
use cot::router::method::openapi::api_post;
use cot::router::{Route, Router};

async fn home(request: Request) -> cot::Result<Response> {
    // ...
}

let route = Route::with_api_handler_and_name("/", api_post(home), "home");
Source

pub fn with_router(url: &str, router: Router) -> Self

Create a new route with the given router.

§Examples
use cot::request::Request;
use cot::response::Response;
use cot::router::{Route, Router};

async fn home(request: Request) -> cot::Result<Response> {
    unimplemented!()
}

let router = Router::with_urls([Route::with_handler_and_name("/", home, "home")]);
let route = Route::with_router("/", router);
Source

pub fn url(&self) -> String

Get the URL for this route.

§Examples
use cot::request::Request;
use cot::response::Response;
use cot::router::{Route, Router};

async fn home(request: Request) -> cot::Result<Response> {
    unimplemented!()
}

let route = Route::with_handler("/test", home);
assert_eq!(route.url(), "/test");
Source

pub fn name(&self) -> Option<&str>

Get the name of this route, if it was created with the Self::with_handler_and_name function.

§Examples
use cot::request::Request;
use cot::response::Response;
use cot::router::{Route, Router};

async fn home(request: Request) -> cot::Result<Response> {
    unimplemented!()
}

let route = Route::with_handler_and_name("/", home, "home");
assert_eq!(route.name(), Some("home"));

Trait Implementations§

Source§

impl Clone for Route

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for Route

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl !RefUnwindSafe for Route

§

impl !UnwindSafe for Route

§

impl Forget for Route

§

impl Freeze for Route

§

impl Send for Route

§

impl Sync for Route

§

impl Unpin for Route

§

impl UnsafeUnpin for Route

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DynClone for T
where T: Clone,

Source§

fn __clone_box(&self, _: Private) -> *mut ()

Source§

impl<T> Fake for T

Source§

fn fake<U>(&self) -> U
where Self: FakeBase<U>,

Source§

fn fake_with_rng<U, R>(&self, rng: &mut R) -> U
where R: RngExt + ?Sized, Self: FakeBase<U>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

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> IntoApi for T

Source§

fn into_api<A>(self) -> UseApi<T, A>
where T: Sized,

into UseApi
Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoField<Auto<T>> for T

Source§

fn into_field(self) -> Auto<T>

Available on crate feature db only.
Converts the type to the field type.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

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

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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