Struct Urls

pub struct Urls { /* private fields */ }

A helper structure to allow reversing URLs from a request handler.

This is mainly useful as an extractor to allow reversing URLs without access to a full Request object.

Examples

use cot::request::Request;
use cot::response::{Response, ResponseExt};
use cot::router::{Route, Router, Urls};
use cot::test::TestRequestBuilder;
use cot::{Body, RequestHandler, StatusCode, reverse};

async fn my_handler(urls: Urls) -> cot::Result<Response> {
    let url = reverse!(urls, "home")?;
    Ok(Response::new_html(
        StatusCode::OK,
        Body::fixed(format!("{url}")),
    ))
}

let router = Router::with_urls([Route::with_handler_and_name("/", my_handler, "home")]);
let request = TestRequestBuilder::get("/").router(router).build();

assert_eq!(
    my_handler
        .handle(request)
        .await?
        .into_body()
        .into_bytes()
        .await?,
    "/"
);

Implementations

impl Urls

pub fn from_request(request: &Request) -> Self

Create a new Urls object from a Request object.

Examples

use cot::request::Request;
use cot::response::{Response, ResponseExt};
use cot::router::Urls;
use cot::{Body, StatusCode, reverse};

async fn my_handler(request: Request) -> cot::Result<Response> {
    let urls = Urls::from_request(&request);
    let url = reverse!(urls, "home")?;
    Ok(Response::new_html(
        StatusCode::OK,
        Body::fixed(format!("Hello! The URL for this view is: {}", url)),
    ))
}

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

Get the app name the current route belongs to, or None if the request is not routed.

This is mainly useful for providing context to reverse redirects, where you want to redirect to a route in the same app.

Examples

use cot::request::{Request, RequestExt};
use cot::response::Response;
use cot::router::Urls;

async fn my_handler(urls: Urls) -> cot::Result<Response> {
    let app_name = urls.app_name();
    // ... do something with the app name
}

pub fn router(&self) -> &Router

Get the router.

Examples

use cot::request::{Request, RequestExt};
use cot::response::Response;
use cot::router::Urls;

async fn my_handler(urls: Urls) -> cot::Result<Response> {
    let router = urls.router();
    // ... do something with the router
}

Trait Implementations

impl Clone for Urls

fn clone(&self) -> Urls

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Urls

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

Formats the value using the given formatter.

impl FromRequestParts for Urls

async fn from_request_parts(parts: &mut Parts) -> Result<Self>

Extracts data from the request parts.