Struct actix_web_lab::middleware::NormalizePath

pub struct NormalizePath { /* private fields */ }

Middleware for normalizing a request’s path so that routes can be matched more flexibly.

Normalization Steps

• Merges consecutive slashes into one. (For example, /path//one always becomes /path/one.)
• Appends a trailing slash if one is not present, removes one if present, or keeps trailing slashes as-is, depending on which TrailingSlash variant is supplied to new.

Default Behavior

The default constructor chooses to strip trailing slashes from the end of paths with them (TrailingSlash::Trim). The implication is that route definitions should be defined without trailing slashes or else they will be inaccessible (or vice versa when using the TrailingSlash::Always behavior), as shown in the example tests below.

Examples

use actix_web::{middleware, web, App};

let app = App::new()
    .wrap(middleware::NormalizePath::trim())
    .route("/test", web::get().to(|| async { "test" }))
    .route("/unmatchable/", web::get().to(|| async { "unmatchable" }));

use actix_web::{
    http::StatusCode,
    test::{call_service, init_service, TestRequest},
};

let app = init_service(app).await;

let req = TestRequest::with_uri("/test").to_request();
let res = call_service(&app, req).await;
assert_eq!(res.status(), StatusCode::OK);

let req = TestRequest::with_uri("/test/").to_request();
let res = call_service(&app, req).await;
assert_eq!(res.status(), StatusCode::OK);

let req = TestRequest::with_uri("/unmatchable").to_request();
let res = call_service(&app, req).await;
assert_eq!(res.status(), StatusCode::NOT_FOUND);

let req = TestRequest::with_uri("/unmatchable/").to_request();
let res = call_service(&app, req).await;
assert_eq!(res.status(), StatusCode::NOT_FOUND);

Implementations

impl NormalizePath

pub fn new(behavior: TrailingSlash) -> Self

Create new NormalizePath middleware with the specified trailing slash style.

pub fn trim() -> Self

Constructs a new NormalizePath middleware with trim semantics.

Use this instead of NormalizePath::default() to avoid deprecation warning.

pub fn use_redirects(self) -> Self

Configures middleware to respond to requests with non-normalized paths with a 307 redirect.

If configured

For example, a request with the path /api//v1/foo/ would receive a response with a Location: /api/v1/foo header (assuming Trim trailing slash behavior.)

To customize the status code, use use_redirects_with.

pub fn use_redirects_with(self, status_code: StatusCode) -> Self

Configures middleware to respond to requests with non-normalized paths with a redirect.

For example, a request with the path /api//v1/foo/ would receive a 307 response with a Location: /api/v1/foo header (assuming Trim trailing slash behavior.)

Panics

Panics if status_code is not a redirect (300-399).

Trait Implementations

impl Clone for NormalizePath

fn clone(&self) -> NormalizePath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for NormalizePath

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

Formats the value using the given formatter.

impl Default for NormalizePath

fn default() -> Self

Returns the “default value” for a type.

impl<S, B> Transform<S, ServiceRequest> for NormalizePath

where S: Service<ServiceRequest, Response = ServiceResponse<B>, Error = Error>, S::Future: 'static,

type Response = ServiceResponse<EitherBody<B, ()>>

Responses produced by the service.

type Error = Error

Errors produced by the service.

type Transform = NormalizePathService<S>

The TransformService value created by this factory

type InitError = ()

Errors produced while building a transform service.

type Future = Ready<Result<<NormalizePath as Transform<S, ServiceRequest>>::Transform, <NormalizePath as Transform<S, ServiceRequest>>::InitError>>

The future response value.

fn new_transform(&self, service: S) -> Self::Future

Creates and returns a new Transform component, asynchronously

impl Copy for NormalizePath