diff --git a/crates/axum-utils/src/http_client_factory.rs b/crates/axum-utils/src/http_client_factory.rs index 25f5b155..6eb5f940 100644 --- a/crates/axum-utils/src/http_client_factory.rs +++ b/crates/axum-utils/src/http_client_factory.rs @@ -56,7 +56,7 @@ impl HttpClientFactory { Ok(layer.layer(client)) } - /// Constructs a new [`HttpService`], suitable for [`mas_oidc_client`] + /// Constructs a new [`HttpService`], suitable for `mas-oidc-client` /// /// # Errors /// diff --git a/crates/data-model/src/compat/session.rs b/crates/data-model/src/compat/session.rs index a5c2c17d..1dbd0722 100644 --- a/crates/data-model/src/compat/session.rs +++ b/crates/data-model/src/compat/session.rs @@ -31,7 +31,7 @@ pub enum CompatSessionState { impl CompatSessionState { /// Returns `true` if the compta session state is [`Valid`]. /// - /// [`Valid`]: ComptaSessionState::Valid + /// [`Valid`]: CompatSessionState::Valid #[must_use] pub fn is_valid(&self) -> bool { matches!(self, Self::Valid) @@ -39,7 +39,7 @@ impl CompatSessionState { /// Returns `true` if the compta session state is [`Finished`]. /// - /// [`Finished`]: ComptaSessionState::Finished + /// [`Finished`]: CompatSessionState::Finished #[must_use] pub fn is_finished(&self) -> bool { matches!(self, Self::Finished { .. }) diff --git a/crates/data-model/src/tokens.rs b/crates/data-model/src/tokens.rs index 120f293e..2d57a663 100644 --- a/crates/data-model/src/tokens.rs +++ b/crates/data-model/src/tokens.rs @@ -40,7 +40,7 @@ impl AccessTokenState { /// Returns `true` if the refresh token state is [`Valid`]. /// - /// [`Valid`]: RefreshTokenState::Valid + /// [`Valid`]: AccessTokenState::Valid #[must_use] pub fn is_valid(&self) -> bool { matches!(self, Self::Valid) @@ -48,7 +48,7 @@ impl AccessTokenState { /// Returns `true` if the refresh token state is [`Revoked`]. /// - /// [`Revoked`]: RefreshTokenState::Revoked + /// [`Revoked`]: AccessTokenState::Revoked #[must_use] pub fn is_revoked(&self) -> bool { matches!(self, Self::Revoked { .. }) diff --git a/crates/keystore/src/lib.rs b/crates/keystore/src/lib.rs index f1a15ee6..0899bcdc 100644 --- a/crates/keystore/src/lib.rs +++ b/crates/keystore/src/lib.rs @@ -15,12 +15,7 @@ //! A crate to store keys which can then be used to sign and verify JWTs. #![forbid(unsafe_code)] -#![deny( - clippy::all, - clippy::str_to_string, - rustdoc::broken_intra_doc_links, - rustdoc::all -)] +#![deny(clippy::all, clippy::str_to_string, rustdoc::broken_intra_doc_links)] #![warn(clippy::pedantic)] use std::{ops::Deref, sync::Arc}; diff --git a/crates/listener/src/lib.rs b/crates/listener/src/lib.rs index 091d5809..5aaabee4 100644 --- a/crates/listener/src/lib.rs +++ b/crates/listener/src/lib.rs @@ -22,6 +22,9 @@ #![warn(clippy::pedantic)] #![allow(clippy::module_name_repetitions)] +//! An utility crate to build flexible [`hyper`] listeners, with optional TLS +//! and proxy protocol support. + use self::{maybe_tls::TlsStreamInfo, proxy_protocol::ProxyProtocolV1Info}; pub mod maybe_tls; diff --git a/crates/listener/src/server.rs b/crates/listener/src/server.rs index c919017f..2527302f 100644 --- a/crates/listener/src/server.rs +++ b/crates/listener/src/server.rs @@ -39,7 +39,7 @@ pub struct Server { impl Server { /// # Errors /// - /// Returns an error if the listener couldn't be converted via [`TryInfo`] + /// Returns an error if the listener couldn't be converted via [`TryInto`] pub fn try_new(listener: L, service: S) -> Result where L: TryInto, diff --git a/crates/spa/src/lib.rs b/crates/spa/src/lib.rs index 58838f28..fbef5386 100644 --- a/crates/spa/src/lib.rs +++ b/crates/spa/src/lib.rs @@ -21,6 +21,8 @@ )] #![warn(clippy::pedantic)] +//! A crate to help serve single-page apps built by Vite. + mod vite; use std::{future::Future, pin::Pin};