remove no longer needed marker

Author: seqre

cot-core/src/error.rs

@@ -1,3 +1,9 @@
+//! Error handling types and utilities for Cot applications.
+//!
+//! This module provides error types, error handlers, and utilities for
+//! handling various types of errors that can occur in Cot applications,
+//! including 404 Not Found errors, uncaught panics, and custom error pages.
+
 pub mod backtrace;
 pub(crate) mod error_impl;
 mod method_not_allowed;

cot-core/src/handler.rs

@@ -1,3 +1,9 @@
+//! Request handler traits and utilities.
+//!
+//! This module provides the [`RequestHandler`] trait, which is the core
+//! abstraction for handling HTTP requests in Cot. It is automatically
+//! implemented for async functions taking extractors and returning responses.
+
 use std::future::Future;
 use std::marker::PhantomData;
 use std::pin::Pin;
@@ -72,12 +78,6 @@ pub fn into_box_request_handler<T, H: RequestHandler<T> + Send + Sync>(
     Inner(handler, PhantomData)
 }
 
-/// Private marker type used to distinguish `FromRequest` parameter position in
-/// trait impls. This is used instead of `()` to avoid coherence conflicts.
-#[doc(hidden)]
-#[expect(missing_copy_implementations, missing_debug_implementations)]
-pub struct FromRequestMarker(());
-
 macro_rules! impl_request_handler {
     ($($ty:ident),*) => {
         impl<Func, $($ty,)* Fut, R> RequestHandler<($($ty,)*)> for Func
@@ -112,7 +112,7 @@ macro_rules! impl_request_handler {
 
 macro_rules! impl_request_handler_from_request {
     ($($ty_lhs:ident,)* ($ty_from_request:ident) $(,$ty_rhs:ident)*) => {
-        impl<Func, $($ty_lhs,)* $ty_from_request, $($ty_rhs,)* Fut, R> RequestHandler<($($ty_lhs,)* $ty_from_request, FromRequestMarker, $($ty_rhs,)*)> for Func
+        impl<Func, $($ty_lhs,)* $ty_from_request, $($ty_rhs,)* Fut, R> RequestHandler<($($ty_lhs,)* $ty_from_request, (), $($ty_rhs,)*)> for Func
         where
             Func: FnOnce($($ty_lhs,)* $ty_from_request, $($ty_rhs),*) -> Fut + Clone + Send + Sync + 'static,
             $($ty_lhs: FromRequestHead + Send,)*
@@ -239,14 +239,16 @@ pub use handle_all_parameters;
 handle_all_parameters!(impl_request_handler);
 handle_all_parameters_from_request!(impl_request_handler_from_request);
 
+#[rustfmt::skip] // `wrap_comments` breaks local links
 /// A wrapper around a handler that's used in
-/// [`Bootstrapper`](cot::Bootstrapper).
+/// [`Bootstrapper`](../../cot/project/struct.Bootstrapper.html).
 ///
 /// It is returned by
-/// [`Bootstrapper::into_bootstrapped_project`](cot::Bootstrapper::finish).
-/// Typically, you don't need to interact with this type directly, except for
-/// creating it in [`Project::middlewares`](cot::Project::middlewares) through
-/// the [`RootHandlerBuilder::build`](cot::project::RootHandlerBuilder::build)
+/// [`Bootstrapper::finish()`](../../cot/project/struct.Bootstrapper.html#method.finish).
+/// Typically, you don't need to interact with this type directly, except
+/// for creating it in
+/// [`Project::middlewares()`](../../cot/project/trait.Project.html#method.middlewares) through the
+/// [`RootHandlerBuilder::build()`](../../cot/project/struct.RootHandlerBuilder.html#method.build)
 /// method.
 ///
 /// # Examples

cot-core/src/headers.rs

@@ -1,3 +1,7 @@
+//! HTTP header constants.
+//!
+//! This module provides commonly used content type header values.
+
 pub const HTML_CONTENT_TYPE: &str = "text/html; charset=utf-8";
 pub const MULTIPART_FORM_CONTENT_TYPE: &str = "multipart/form-data";
 pub const URLENCODED_FORM_CONTENT_TYPE: &str = "application/x-www-form-urlencoded";

cot-core/src/lib.rs

@@ -1,3 +1,13 @@
+//! Core types and functionality for the Cot web framework.
+//!
+//! This crate provides the foundational building blocks for
+//! [Cot](https://docs.rs/cot/latest/cot/), including HTTP primitives, body handling, error
+//! types, handlers, middleware, and request/response types.
+//!
+//! Most applications should use the main `cot` crate rather than depending on
+//! `cot-core` directly. This crate is primarily intended for internal use by
+//! the Cot framework and for building custom extensions.
+
 mod body;
 
 pub mod error;

cot-core/src/middleware.rs

@@ -1,3 +1,9 @@
+//! Middlewares for modifying requests and responses.
+//!
+//! Middlewares are used to modify requests and responses in a pipeline. They
+//! are used to add functionality to the request/response cycle, such as
+//! session management, adding security headers, and more.
+
 use std::fmt::Debug;
 use std::task::{Context, Poll};
 
@@ -11,13 +17,14 @@ use crate::request::Request;
 use crate::response::Response;
 use crate::{Body, Error};
 
-/// Middleware that converts a any [`http::Response`] generic type to a
-/// [`cot::response::Response`].
+#[rustfmt::skip] // `wrap_comments` breaks local links
+/// Middleware that converts any [`http::Response`] generic type
+/// to a [`Response`].
 ///
 /// This is useful for converting a response from a middleware that is
 /// compatible with the `tower` crate to a response that is compatible with
 /// Cot. It's applied automatically by
-/// [`RootHandlerBuilder::middleware()`](cot::project::RootHandlerBuilder::middleware())
+/// [`RootHandlerBuilder::middleware()`](../../cot/project/struct.RootHandlerBuilder.html#method.middleware)
 /// and is not needed to be added manually.
 ///
 /// # Examples
@@ -74,8 +81,8 @@ impl<S> tower::Layer<S> for IntoCotResponseLayer {
     }
 }
 
-/// Service struct that converts any [`http::Response`] generic type to
-/// [`cot::response::Response`].
+/// Service struct that converts any [`http::Response`] generic
+/// type to [`Response`].
 ///
 /// Used by [`IntoCotResponseLayer`].
 ///
@@ -125,12 +132,13 @@ where
     response.map(|body| Body::wrapper(BoxBody::new(body.map_err(map_err))))
 }
 
-/// Middleware that converts any error type to [`cot::Error`].
+#[rustfmt::skip] // `wrap_comments` breaks local links
+/// Middleware that converts any error type to [`Error`].
 ///
 /// This is useful for converting a response from a middleware that is
 /// compatible with the `tower` crate to a response that is compatible with
 /// Cot. It's applied automatically by
-/// [`RootHandlerBuilder::middleware()`](cot::project::RootHandlerBuilder::middleware())
+/// [`RootHandlerBuilder::middleware`](../../cot/project/struct.RootHandlerBuilder.html#method.middleware)
 /// and is not needed to be added manually.
 ///
 /// # Examples
@@ -187,7 +195,7 @@ impl<S> tower::Layer<S> for IntoCotErrorLayer {
     }
 }
 
-/// Service struct that converts a any error type to a [`cot::Error`].
+/// Service struct that converts a any error type to a [`Error`].
 ///
 /// Used by [`IntoCotErrorLayer`].
 ///

cot-core/src/request.rs

@@ -2,11 +2,12 @@
 //!
 //! Cot uses the [`Request`](http::Request) type from the [`http`] crate
 //! to represent incoming HTTP requests. However, it also provides a
-//! [`RequestExt`] 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`] in your code most of the time to be
-//! able to use these functions:
+//! [`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;
@@ -45,7 +46,7 @@ pub struct RouteName(pub String);
 /// Path parameters extracted from the request URL, and available as a map of
 /// strings.
 ///
-/// This struct is meant to be mainly used using the [`PathParams::parse`]
+/// This struct is meant to be mainly used via the [`PathParams::parse`]
 /// method, which will deserialize the path parameters into a type `T`
 /// implementing `serde::DeserializeOwned`. If needed, you can also access the
 /// path parameters directly using the [`PathParams::get`] method.

cot-core/src/response.rs

@@ -122,8 +122,9 @@ pub trait ResponseExt: Sized + private::Sealed {
     ///
     /// # See also
     ///
-    /// * [`crate::reverse_redirect!`] – a more ergonomic way to create
-    ///   redirects to internal views
+    /// * [`cot::reverse_redirect!`](../../cot/macro.reverse_redirect!.html) – a
+    ///   more ergonomic way to create redirects to internal views (available in
+    ///   the `cot` crate)
     #[must_use]
     fn new_redirect<T: Into<String>>(location: T) -> Self;
 }

cot/src/error.rs

@@ -1,3 +1,9 @@
+//! Error handling types and utilities for Cot applications.
+//!
+//! This module provides error types, error handlers, and utilities for
+//! handling various types of errors that can occur in Cot applications,
+//! including 404 Not Found errors, uncaught panics, and custom error pages.
+
 pub mod handler;
 
 #[doc(inline)]

cot/src/error/handler.rs

@@ -20,7 +20,7 @@ use crate::response::Response;
 /// This trait is implemented by functions that can handle error pages. The
 /// trait is automatically implemented for async functions that take parameters
 /// implementing [`FromRequestHead`] and return a type that implements
-/// [`IntoResponse`].
+/// [`IntoResponse`](crate::response::IntoResponse).
 ///
 /// # Examples
 ///

cot/src/lib.rs

@@ -55,11 +55,6 @@ pub mod cache;
 
 #[cfg(feature = "db")]
 pub mod db;
-/// Error handling types and utilities for Cot applications.
-///
-/// This module provides error types, error handlers, and utilities for
-/// handling various types of errors that can occur in Cot applications,
-/// including 404 Not Found errors, uncaught panics, and custom error pages.
 pub mod error;
 pub mod form;
 // Not public API. Referenced by macro-generated code.