From 34d1fbc052f2a12d139836c54b78f120fe272847 Mon Sep 17 00:00:00 2001 From: Jonas Platte Date: Tue, 8 Aug 2023 10:40:44 +0200 Subject: [PATCH] Fix typos found by crate-ci/typos --- ECOSYSTEM.md | 2 +- axum-extra/src/extract/cookie/mod.rs | 2 +- axum-extra/src/extract/cookie/private.rs | 2 +- axum-extra/src/extract/cookie/signed.rs | 2 +- axum-extra/src/extract/multipart.rs | 2 +- axum-extra/src/handler/mod.rs | 2 +- axum-extra/src/routing/typed.rs | 2 +- axum/src/docs/extract.md | 2 +- axum/src/docs/method_routing/layer.md | 4 ++-- axum/src/response/sse.rs | 2 +- axum/src/routing/method_routing.rs | 2 +- axum/src/routing/tests/fallback.rs | 2 +- 12 files changed, 13 insertions(+), 13 deletions(-) diff --git a/ECOSYSTEM.md b/ECOSYSTEM.md index 5dedcb48..b57708a0 100644 --- a/ECOSYSTEM.md +++ b/ECOSYSTEM.md @@ -13,7 +13,7 @@ If your project isn't listed here and you would like it to be, please feel free - [aliri_axum](https://docs.rs/aliri_axum) and [aliri_tower](https://docs.rs/aliri_tower): JWT validation middleware and OAuth2 scopes enforcing extractors. - [ezsockets](https://github.com/gbaranski/ezsockets): Easy to use WebSocket library that integrates with Axum. - [axum_session](https://github.com/AscendingCreations/AxumSessions): Database persistent sessions like pythons flask_sessionstore for Axum. -- [axum_session_auth](https://github.com/AscendingCreations/AxumSessionsAuth): Persistant session based user login with rights management for Axum. +- [axum_session_auth](https://github.com/AscendingCreations/AxumSessionsAuth): Persistent session based user login with rights management for Axum. - [axum-auth](https://crates.io/crates/axum-auth): High-level http auth extractors for axum. - [axum-keycloak-auth](https://github.com/lpotthast/axum-keycloak-auth): Protect axum routes with a JWT emitted by Keycloak. - [shuttle](https://github.com/getsynth/shuttle): A serverless platform built for Rust. Now with axum support. diff --git a/axum-extra/src/extract/cookie/mod.rs b/axum-extra/src/extract/cookie/mod.rs index e0b84c7c..ef33ce76 100644 --- a/axum-extra/src/extract/cookie/mod.rs +++ b/axum-extra/src/extract/cookie/mod.rs @@ -130,7 +130,7 @@ impl CookieJar { /// Create a new empty `CookieJar`. /// - /// This is inteded to be used in middleware and other places where it might be difficult to + /// This is intended to be used in middleware and other places where it might be difficult to /// run extractors. Normally you should create `CookieJar`s through [`FromRequestParts`]. /// /// If you need a jar that contains the headers from a request use `impl From<&HeaderMap> for diff --git a/axum-extra/src/extract/cookie/private.rs b/axum-extra/src/extract/cookie/private.rs index d82538b9..df2c6ae9 100644 --- a/axum-extra/src/extract/cookie/private.rs +++ b/axum-extra/src/extract/cookie/private.rs @@ -173,7 +173,7 @@ impl PrivateCookieJar { /// Create a new empty `PrivateCookieJarIter`. /// - /// This is inteded to be used in middleware and other places where it might be difficult to + /// This is intended to be used in middleware and other places where it might be difficult to /// run extractors. Normally you should create `PrivateCookieJar`s through [`FromRequestParts`]. /// /// [`FromRequestParts`]: axum::extract::FromRequestParts diff --git a/axum-extra/src/extract/cookie/signed.rs b/axum-extra/src/extract/cookie/signed.rs index 6025d37c..1489d271 100644 --- a/axum-extra/src/extract/cookie/signed.rs +++ b/axum-extra/src/extract/cookie/signed.rs @@ -190,7 +190,7 @@ impl SignedCookieJar { /// Create a new empty `SignedCookieJar`. /// - /// This is inteded to be used in middleware and other places where it might be difficult to + /// This is intended to be used in middleware and other places where it might be difficult to /// run extractors. Normally you should create `SignedCookieJar`s through [`FromRequestParts`]. /// /// [`FromRequestParts`]: axum::extract::FromRequestParts diff --git a/axum-extra/src/extract/multipart.rs b/axum-extra/src/extract/multipart.rs index 3340e48b..f6fd7565 100644 --- a/axum-extra/src/extract/multipart.rs +++ b/axum-extra/src/extract/multipart.rs @@ -72,7 +72,7 @@ use std::{ /// ``` /// /// In general you should consume `Multipart` by looping over the fields in order and make sure not -/// to keep `Field`s around from previous loop iterations. That will mimimize the risk of runtime +/// to keep `Field`s around from previous loop iterations. That will minimize the risk of runtime /// errors. /// /// # Differences between this and `axum::extract::Multipart` diff --git a/axum-extra/src/handler/mod.rs b/axum-extra/src/handler/mod.rs index d017b41e..4017e149 100644 --- a/axum-extra/src/handler/mod.rs +++ b/axum-extra/src/handler/mod.rs @@ -28,7 +28,7 @@ pub trait HandlerCallWithExtractors: Sized { /// Call the handler with the extracted inputs. fn call(self, extractors: T, state: S) -> >::Future; - /// Conver this `HandlerCallWithExtractors` into [`Handler`]. + /// Convert this `HandlerCallWithExtractors` into [`Handler`]. fn into_handler(self) -> IntoHandler { IntoHandler { handler: self, diff --git a/axum-extra/src/routing/typed.rs b/axum-extra/src/routing/typed.rs index 8cb9e348..ef30462a 100644 --- a/axum-extra/src/routing/typed.rs +++ b/axum-extra/src/routing/typed.rs @@ -145,7 +145,7 @@ use serde::Serialize; /// /// ## Customizing the rejection /// -/// By default the rejection used in the [`FromRequest`] implemetation will be [`PathRejection`]. +/// By default the rejection used in the [`FromRequest`] implementation will be [`PathRejection`]. /// /// That can be customized using `#[typed_path("...", rejection(YourType))]`: /// diff --git a/axum/src/docs/extract.md b/axum/src/docs/extract.md index 763fd9b0..f7669f44 100644 --- a/axum/src/docs/extract.md +++ b/axum/src/docs/extract.md @@ -291,7 +291,7 @@ options: 1. Use `Result` as your extractor like shown in ["Optional extractors"](#optional-extractors). This works well if you're only using the extractor in a single handler. -2. Create your own extractor that in its [`FromRequest`] implemention calls +2. Create your own extractor that in its [`FromRequest`] implementation calls one of axum's built in extractors but returns a different response for rejections. See the [customize-extractor-error] example for more details. diff --git a/axum/src/docs/method_routing/layer.md b/axum/src/docs/method_routing/layer.md index 7ceadd4d..e155ee51 100644 --- a/axum/src/docs/method_routing/layer.md +++ b/axum/src/docs/method_routing/layer.md @@ -16,12 +16,12 @@ more details. use axum::{routing::get, Router}; use tower::limit::ConcurrencyLimitLayer; -async fn hander() {} +async fn handler() {} let app = Router::new().route( "/", // All requests to `GET /` will be sent through `ConcurrencyLimitLayer` - get(hander).layer(ConcurrencyLimitLayer::new(64)), + get(handler).layer(ConcurrencyLimitLayer::new(64)), ); # let _: Router = app; ``` diff --git a/axum/src/response/sse.rs b/axum/src/response/sse.rs index 55947f1b..679e03d1 100644 --- a/axum/src/response/sse.rs +++ b/axum/src/response/sse.rs @@ -687,7 +687,7 @@ mod tests { } #[test] - fn memchr_spliting() { + fn memchr_splitting() { assert_eq!( memchr_split(2, &[]).collect::>(), [&[]] as [&[u8]; 1] diff --git a/axum/src/routing/method_routing.rs b/axum/src/routing/method_routing.rs index 98b71950..053c9918 100644 --- a/axum/src/routing/method_routing.rs +++ b/axum/src/routing/method_routing.rs @@ -1343,7 +1343,7 @@ mod tests { } #[allow(dead_code)] - async fn buiding_complex_router() { + async fn building_complex_router() { let app = crate::Router::new().route( "/", // use the all the things 💣️ diff --git a/axum/src/routing/tests/fallback.rs b/axum/src/routing/tests/fallback.rs index 33b14f6c..d0800467 100644 --- a/axum/src/routing/tests/fallback.rs +++ b/axum/src/routing/tests/fallback.rs @@ -82,7 +82,7 @@ async fn nested_router_inherits_fallback() { } #[crate::test] -async fn doesnt_inherit_fallback_if_overriden() { +async fn doesnt_inherit_fallback_if_overridden() { let inner = Router::new().fallback(inner_fallback); let app = Router::new().nest("/foo", inner).fallback(outer_fallback);