itsscb/axum
1
0
Fork 0
mirror of https://github.com/tokio-rs/axum.git synced 2025-10-02 15:24:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rename .route() / .nest() "description" to "path" (#265)

Browse Source
This commit is contained in:
Jonas Platte 2021-08-24 19:29:28 +02:00 committed by GitHub
parent 9a082a74b0
commit ab207af060
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

19
src/routing/mod.rs
View File

@ -85,7 +85,7 @@ where
impl<S> Router<S> { impl<S> Router<S> {
/// Add another route to the router. /// Add another route to the router.
/// ///
/// `description` is a string of path segments separated by `/`. Each segment /// `path` is a string of path segments separated by `/`. Each segment
/// can be either concrete or a capture: /// can be either concrete or a capture:
/// ///
/// - `/foo/bar/baz` will only match requests where the path is `/foo/bar/bar`. /// - `/foo/bar/baz` will only match requests where the path is `/foo/bar/bar`.
@ -93,7 +93,7 @@ impl<S> Router<S> {
/// capture the first segment and store it at the key `foo`. /// capture the first segment and store it at the key `foo`.
/// ///
/// `service` is the [`Service`] that should receive the request if the path /// `service` is the [`Service`] that should receive the request if the path
/// matches `description`. /// matches `path`.
/// ///
/// # Example /// # Example
/// ///
@ -122,10 +122,10 @@ impl<S> Router<S> {
/// ///
/// # Panics /// # Panics
/// ///
/// Panics if `description` doesn't start with `/`. /// Panics if `path` doesn't start with `/`.
pub fn route<T>(self, description: &str, svc: T) -> Router<Route<T, S>> { pub fn route<T>(self, path: &str, svc: T) -> Router<Route<T, S>> {
self.map(|fallback| Route { self.map(|fallback| Route {
pattern: PathPattern::new(description), pattern: PathPattern::new(path),
svc, svc,
fallback, fallback,
}) })
@ -217,9 +217,9 @@ impl<S> Router<S> {
/// `nest`. /// `nest`.
/// ///
/// [`OriginalUri`]: crate::extract::OriginalUri /// [`OriginalUri`]: crate::extract::OriginalUri
pub fn nest<T>(self, description: &str, svc: T) -> Router<Nested<T, S>> { pub fn nest<T>(self, path: &str, svc: T) -> Router<Nested<T, S>> {
self.map(|fallback| Nested { self.map(|fallback| Nested {
pattern: PathPattern::new(description), pattern: PathPattern::new(path),
svc, svc,
fallback, fallback,
}) })
@ -752,10 +752,7 @@ struct Inner {
impl PathPattern { impl PathPattern {
pub(crate) fn new(pattern: &str) -> Self { pub(crate) fn new(pattern: &str) -> Self {
assert!( assert!(pattern.starts_with('/'), "Route path must start with a `/`");
pattern.starts_with('/'),
"Route description must start with a `/`"
);
let mut capture_group_names = Vec::new(); let mut capture_group_names = Vec::new();