berkus
/
actix-web
mirror of https://github.com/fafhrd91/actix-web
1
0
Fork 0
Code Issues Releases Wiki Activity

docs(actix-router): document Resource trait (#3935) 

Co-authored-by: Yuki Okushi <huyuumi.dev@gmail.com>
This commit is contained in:
augustin 2026-02-17 07:27:14 +09:00 committed by GitHub
parent 36dadc5351
commit f120479030
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 7 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
actix-router/src/resource_path.rs
View File

@ -1,11 +1,16 @@
use crate::Path; use crate::Path;
// TODO: this trait is necessary, document it /// Abstraction over types that can provide a mutable [`Path`] for routing.
// see impl Resource for ServiceRequest ///
/// This trait is used by the router to extract the request path in a uniform way across different
/// request types (e.g., Actix Web's `ServiceRequest`). Implementors return a mutable [`Path`]
/// wrapper so routing can read and potentially normalize/parse the path without requiring the
/// original request type.
pub trait Resource { pub trait Resource {
/// Type of resource's path returned in `resource_path`. /// Type of resource's path returned in `resource_path`.
type Path: ResourcePath; type Path: ResourcePath;
/// Returns a mutable reference to the path wrapper used by the router.
fn resource_path(&mut self) -> &mut Path<Self::Path>; fn resource_path(&mut self) -> &mut Path<Self::Path>;
} }