final review changes

seqre · seqre · commit f813f7c74cff · 2026-01-26T18:28:14.000+01:00
diff --git a/cot-core/src/request.rs b/cot-core/src/request.rs
@@ -1,18 +1,3 @@
-//! HTTP request type and helper methods.
-//!
-//! Cot uses the [`Request`](http::Request) type from the [`http`] crate
-//! to represent incoming HTTP requests. However, it also provides a
-//! [`RequestExt`](../../cot/request/trait.RequestExt.html) trait that contain
-//! various helper methods for working with HTTP requests. These methods are
-//! used to access the application context, project configuration, path
-//! parameters, and more. You probably want to have a `use` statement for
-//! [`RequestExt`](../../cot/request/trait.RequestExt.html) in your code most of
-//! the time to be able to use these functions:
-//!
-//! ```
-//! use cot::request::RequestExt;
-//! ```
-
 use indexmap::IndexMap;
 
 use crate::Body;
diff --git a/cot-core/src/request/extractors.rs b/cot-core/src/request/extractors.rs
@@ -57,13 +57,6 @@ use crate::json::Json;
 use crate::request::{InvalidContentType, PathParams, Request, RequestHead};
 use crate::{Body, Method};
 
-/// Trait for extractors that consume the request body.
-///
-/// Extractors implementing this trait are used in route handlers that consume
-/// the request body and therefore can only be used once per request.
-///
-/// See [`crate::request::extractors`] documentation for more information about
-/// extractors.
 pub trait FromRequest: Sized {
     /// Extracts data from the request.
     ///
@@ -83,14 +76,6 @@ impl FromRequest for Request {
     }
 }
 
-/// Trait for extractors that don't consume the request body.
-///
-/// Extractors implementing this trait are used in route handlers that don't
-/// consume the request and therefore can be used multiple times per request.
-///
-/// If you need to consume the body of the request, use [`FromRequest`] instead.
-///
-/// See [`crate::request::extractors`] documentation for more information about
 /// extractors.
 pub trait FromRequestHead: Sized {
     /// Extracts data from the request head.
@@ -105,7 +90,7 @@ pub trait FromRequestHead: Sized {
 /// An extractor that extracts data from the URL params.
 ///
 /// The extractor is generic over a type that implements
-/// `serde::de::DeserializeOwned`.
+/// [`DeserializeOwned`].
 ///
 /// # Examples
 ///
@@ -160,7 +145,7 @@ impl<D: DeserializeOwned> FromRequestHead for Path<D> {
 /// An extractor that extracts data from the URL query parameters.
 ///
 /// The extractor is generic over a type that implements
-/// `serde::de::DeserializeOwned`.
+/// [`DeserializeOwned`].
 ///
 /// # Example
 ///
@@ -223,7 +208,7 @@ struct QueryParametersParseError(serde_path_to_error::Error<serde::de::value::Er
 impl_into_cot_error!(QueryParametersParseError, BAD_REQUEST);
 
 /// Extractor that gets the request body as JSON and deserializes it into a type
-/// `T` implementing `serde::de::DeserializeOwned`.
+/// `T` implementing [`DeserializeOwned`].
 ///
 /// The content type of the request must be `application/json`.
 ///
diff --git a/cot-core/src/response.rs b/cot-core/src/response.rs
@@ -1,17 +1,3 @@
-//! HTTP response type and helper methods.
-//!
-//! Cot uses the [`Response`](http::Response) type from the [`http`] crate
-//! to represent outgoing HTTP responses. However, it also provides a
-//! [`ResponseExt`] trait that contain various helper methods for working with
-//! HTTP responses. These methods are used to create new responses with HTML
-//! content types, redirects, and more. You probably want to have a `use`
-//! statement for [`ResponseExt`] in your code most of the time to be able to
-//! use these functions:
-//!
-//! ```
-//! use cot::response::ResponseExt;
-//! ```
-
 use crate::{Body, StatusCode};
 
 mod into_response;
diff --git a/cot/src/auth.rs b/cot/src/auth.rs
@@ -16,6 +16,7 @@ use std::sync::{Arc, Mutex, MutexGuard};
 /// backwards compatible shim for form Password type.
 use async_trait::async_trait;
 use chrono::{DateTime, FixedOffset};
+use cot_core::error::impl_into_cot_error;
 use derive_more::with_trait::Debug;
 #[cfg(test)]
 use mockall::automock;
@@ -27,7 +28,6 @@ use thiserror::Error;
 use crate::config::SecretKey;
 #[cfg(feature = "db")]
 use crate::db::{ColumnType, DatabaseField, DbValue, FromDbValue, SqlxValueRef, ToDbValue};
-use crate::error::impl_into_cot_error;
 use crate::request::{Request, RequestExt};
 use crate::session::Session;
 
diff --git a/cot/src/cache.rs b/cot/src/cache.rs
@@ -116,6 +116,7 @@ use std::future::Future;
 use std::sync::Arc;
 
 use cot::config::CacheStoreTypeConfig;
+use cot_core::error::impl_into_cot_error;
 use derive_more::with_trait::Debug;
 use serde::Serialize;
 use serde::de::DeserializeOwned;
@@ -126,7 +127,6 @@ use crate::cache::store::memory::Memory;
 use crate::cache::store::redis::Redis;
 use crate::cache::store::{BoxCacheStore, CacheStore};
 use crate::config::{CacheConfig, Timeout};
-use crate::error::impl_into_cot_error;
 
 /// An error that can occur when interacting with the cache.
 #[derive(Debug, Error)]
diff --git a/cot/src/cache/store.rs b/cot/src/cache/store.rs
@@ -12,11 +12,11 @@ pub mod redis;
 use std::fmt::Debug;
 use std::pin::Pin;
 
+use cot_core::error::impl_into_cot_error;
 use serde_json::Value;
 use thiserror::Error;
 
 use crate::config::Timeout;
-use crate::error::impl_into_cot_error;
 
 const CACHE_STORE_ERROR_PREFIX: &str = "cache store error:";
 
diff --git a/cot/src/cache/store/redis.rs b/cot/src/cache/store/redis.rs
@@ -18,14 +18,14 @@
 //! # }
 use cot::cache::store::CacheStoreResult;
 use cot::config::Timeout;
+use cot_core::error::impl_into_cot_error;
 use deadpool_redis::{Config, Connection, Pool, Runtime};
 use redis::{AsyncCommands, SetExpiry, SetOptions};
 use serde_json::Value;
 use thiserror::Error;
 
 use crate::cache::store::{CacheStore, CacheStoreError};
 use crate::config::CacheUrl;
-use crate::error::impl_into_cot_error;
 
 const ERROR_PREFIX: &str = "redis cache store error:";
 
diff --git a/cot/src/config.rs b/cot/src/config.rs
@@ -19,6 +19,7 @@ use std::path::PathBuf;
 use std::time::Duration;
 
 use chrono::{DateTime, FixedOffset, Utc};
+use cot_core::error::impl_into_cot_error;
 use derive_builder::Builder;
 use derive_more::with_trait::{Debug, From};
 use serde::{Deserialize, Serialize};
@@ -27,7 +28,6 @@ use thiserror::Error;
 
 #[cfg(feature = "email")]
 use crate::email::transport::smtp::Mechanism;
-use crate::error::impl_into_cot_error;
 use crate::utils::chrono::DateTimeWithOffsetAdapter;
 
 /// The configuration for a project.
diff --git a/cot/src/db.rs b/cot/src/db.rs
@@ -21,6 +21,7 @@ use std::str::FromStr;
 use std::sync::Arc;
 
 use async_trait::async_trait;
+use cot_core::error::impl_into_cot_error;
 pub use cot_macros::{model, query};
 use derive_more::{Debug, Deref, Display};
 #[cfg(test)]
@@ -42,7 +43,6 @@ use crate::db::impl_postgres::{DatabasePostgres, PostgresRow, PostgresValueRef};
 #[cfg(feature = "sqlite")]
 use crate::db::impl_sqlite::{DatabaseSqlite, SqliteRow, SqliteValueRef};
 use crate::db::migrations::ColumnTypeMapper;
-use crate::error::impl_into_cot_error;
 
 const ERROR_PREFIX: &str = "database error:";
 /// An error that can occur when interacting with the database.
diff --git a/cot/src/email.rs b/cot/src/email.rs
@@ -32,14 +32,14 @@ use std::sync::Arc;
 
 use cot::config::{EmailConfig, EmailTransportTypeConfig};
 use cot::email::transport::smtp::Smtp;
+use cot_core::error::impl_into_cot_error;
 use derive_builder::Builder;
 use derive_more::with_trait::Debug;
 use thiserror::Error;
 use transport::{BoxedTransport, Transport};
 
 use crate::email::transport::TransportError;
 use crate::email::transport::console::Console;
-use crate::error::impl_into_cot_error;
 const ERROR_PREFIX: &str = "email message build error:";
 
 /// Represents errors that can occur when sending an email.
diff --git a/cot/src/email/transport.rs b/cot/src/email/transport.rs
@@ -8,10 +8,10 @@ use std::future::Future;
 use std::pin::Pin;
 
 use cot::email::EmailMessageError;
+use cot_core::error::impl_into_cot_error;
 use thiserror::Error;
 
 use crate::email::EmailMessage;
-use crate::error::impl_into_cot_error;
 
 pub mod console;
 pub mod smtp;
diff --git a/cot/src/error.rs b/cot/src/error.rs
@@ -9,6 +9,4 @@ mod not_found;
 
 #[doc(inline)]
 pub use cot_core::error::{MethodNotAllowed, UncaughtPanic};
-#[doc(inline)]
-pub(crate) use cot_core::error::{backtrace, impl_into_cot_error};
 pub use not_found::{Kind as NotFoundKind, NotFound};
diff --git a/cot/src/error/handler.rs b/cot/src/error/handler.rs
@@ -7,10 +7,10 @@ use std::pin::Pin;
 use std::sync::Arc;
 use std::task::{Context, Poll};
 
+use cot_core::handler::handle_all_parameters;
 use derive_more::with_trait::Debug;
 
 use crate::Error;
-use crate::handler::handle_all_parameters;
 use crate::request::extractors::FromRequestHead;
 use crate::request::{Request, RequestHead};
 use crate::response::Response;
diff --git a/cot/src/error/not_found.rs b/cot/src/error/not_found.rs
@@ -1,9 +1,8 @@
 //! Error types and utilities for handling "404 Not Found" errors.
 
+use cot_core::error::impl_into_cot_error;
 use thiserror::Error;
 
-use crate::error::impl_into_cot_error;
-
 #[expect(clippy::doc_link_with_quotes, reason = "404 Not Found link")]
 /// A ["404 Not Found"] error that can be returned by Cot applications.
 ///
diff --git a/cot/src/error_page.rs b/cot/src/error_page.rs
@@ -2,11 +2,11 @@ use std::any::Any;
 use std::panic::PanicHookInfo;
 use std::sync::Arc;
 
+use cot_core::error::backtrace::{__cot_create_backtrace, Backtrace};
 use tracing::{Level, error, warn};
 
 use crate::config::ProjectConfig;
 use crate::error::NotFound;
-use crate::error::backtrace::{__cot_create_backtrace, Backtrace};
 use crate::router::Router;
 use crate::{Error, Result, StatusCode, Template};
 
@@ -79,6 +79,7 @@ impl ErrorPageTemplateBuilder {
                     Self::build_error_data(&mut error_data, error);
                     error_message = Some(message.clone());
                 }
+                // We don't need to build error data for Kind::FromRouter
                 _ => {}
             }
         }
@@ -326,7 +327,7 @@ fn build_response(
             .status(status_code)
             .header(
                 http::header::CONTENT_TYPE,
-                crate::headers::HTML_CONTENT_TYPE,
+                cot_core::headers::HTML_CONTENT_TYPE,
             )
             .body(axum::body::Body::new(error_str))
             .unwrap_or_else(|_| build_cot_failure_page()),
diff --git a/cot/src/form.rs b/cot/src/form.rs
@@ -31,6 +31,8 @@ use async_trait::async_trait;
 use bytes::Bytes;
 use chrono::NaiveDateTime;
 use chrono_tz::Tz;
+use cot_core::error::impl_into_cot_error;
+use cot_core::headers::{MULTIPART_FORM_CONTENT_TYPE, URLENCODED_FORM_CONTENT_TYPE};
 /// Derive the [`Form`] trait for a struct and create a [`FormContext`] for it.
 ///
 /// This macro will generate an implementation of the [`Form`] trait for the
@@ -61,8 +63,6 @@ pub use field_value::{FormFieldValue, FormFieldValueError};
 use http_body_util::BodyExt;
 use thiserror::Error;
 
-use crate::error::impl_into_cot_error;
-use crate::headers::{MULTIPART_FORM_CONTENT_TYPE, URLENCODED_FORM_CONTENT_TYPE};
 use crate::request::{Request, RequestExt};
 
 const ERROR_PREFIX: &str = "failed to process a form:";
@@ -657,10 +657,10 @@ pub trait AsFormField {
 #[cfg(test)]
 mod tests {
     use bytes::Bytes;
+    use cot_core::headers::{MULTIPART_FORM_CONTENT_TYPE, URLENCODED_FORM_CONTENT_TYPE};
 
     use super::*;
     use crate::Body;
-    use crate::headers::{MULTIPART_FORM_CONTENT_TYPE, URLENCODED_FORM_CONTENT_TYPE};
 
     #[cot::test]
     async fn urlencoded_form_data_extract_get_empty() {
diff --git a/cot/src/form/field_value.rs b/cot/src/form/field_value.rs
@@ -2,10 +2,9 @@ use std::error::Error as StdError;
 use std::fmt::Display;
 
 use bytes::Bytes;
+use cot_core::error::impl_into_cot_error;
 use thiserror::Error;
 
-use crate::error::impl_into_cot_error;
-
 /// A value from a form field.
 ///
 /// This type represents a value from a form field, which can be either a text
diff --git a/cot/src/lib.rs b/cot/src/lib.rs
@@ -69,8 +69,6 @@ pub mod config;
 #[cfg(feature = "email")]
 pub mod email;
 mod error_page;
-#[doc(inline)]
-pub(crate) use cot_core::handler;
 pub mod middleware;
 #[cfg(feature = "openapi")]
 pub mod openapi;
@@ -86,8 +84,35 @@ pub(crate) mod utils;
 
 #[cfg(feature = "openapi")]
 pub use aide;
-#[doc(inline)]
-pub(crate) use cot_core::headers;
+/// A wrapper around a handler that's used in [`Bootstrapper`].
+///
+/// It is returned by [`Bootstrapper::finish`]. Typically, you don't need to
+/// interact with this type directly, except for creating it in
+/// [`Project::middlewares`] through the
+/// [`RootHandlerBuilder::build`](crate::project::RootHandlerBuilder::build)
+/// method.
+///
+/// # Examples
+///
+/// ```
+/// use cot::config::ProjectConfig;
+/// use cot::{Bootstrapper, BoxedHandler, Project};
+///
+/// struct MyProject;
+/// impl Project for MyProject {}
+///
+/// # #[tokio::main]
+/// # async fn main() -> cot::Result<()> {
+/// let bootstrapper = Bootstrapper::new(MyProject)
+///     .with_config(ProjectConfig::default())
+///     .boot()
+///     .await?;
+/// let handler: BoxedHandler = bootstrapper.finish().handler;
+/// # Ok(())
+/// # }
+/// ```
+pub use cot_core::handler::BoxedHandler;
+pub use cot_core::handler::RequestHandler;
 #[cfg(feature = "json")]
 #[doc(inline)]
 pub use cot_core::json;
@@ -161,35 +186,6 @@ pub use schemars;
 pub use {bytes, http};
 
 pub use crate::__private::askama::{Template, filter_fn};
-/// A wrapper around a handler that's used in [`Bootstrapper`].
-///
-/// It is returned by [`Bootstrapper::finish`]. Typically, you don't need to
-/// interact with this type directly, except for creating it in
-/// [`Project::middlewares`] through the
-/// [`RootHandlerBuilder::build`](crate::project::RootHandlerBuilder::build)
-/// method.
-///
-/// # Examples
-///
-/// ```
-/// use cot::config::ProjectConfig;
-/// use cot::{Bootstrapper, BoxedHandler, Project};
-///
-/// struct MyProject;
-/// impl Project for MyProject {}
-///
-/// # #[tokio::main]
-/// # async fn main() -> cot::Result<()> {
-/// let bootstrapper = Bootstrapper::new(MyProject)
-///     .with_config(ProjectConfig::default())
-///     .boot()
-///     .await?;
-/// let handler: BoxedHandler = bootstrapper.finish().handler;
-/// # Ok(())
-/// # }
-/// ```
-pub use crate::handler::BoxedHandler;
-pub use crate::handler::RequestHandler;
 pub use crate::project::{
     App, AppBuilder, Bootstrapper, Project, ProjectContext, run, run_at, run_cli,
 };
diff --git a/cot/src/openapi.rs b/cot/src/openapi.rs
diff --git a/cot/src/project.rs b/cot/src/project.rs
diff --git a/cot/src/request.rs b/cot/src/request.rs
diff --git a/cot/src/request/extractors.rs b/cot/src/request/extractors.rs
diff --git a/cot/src/router.rs b/cot/src/router.rs
diff --git a/cot/src/router/method.rs b/cot/src/router/method.rs
diff --git a/cot/src/router/path.rs b/cot/src/router/path.rs
diff --git a/cot/src/static_files.rs b/cot/src/static_files.rs
diff --git a/cot/src/test.rs b/cot/src/test.rs
