fix: clippy (#9)

Author: NexVeridian

.github/workflows/example.yaml

@@ -9,7 +9,6 @@ on:
 env:
   RUST_TOOLCHAIN: stable
   TOOLCHAIN_PROFILE: minimal
-  CARGO_MANIFEST_DIR: ./example
 
 jobs:
   rustfmt:
@@ -51,7 +50,7 @@ jobs:
         uses: actions-rs/cargo@v1
         with:
           command: clippy
-          args: --all-features -- -D warnings -W clippy::pedantic -W clippy::nursery -W rust-2018-idioms
+          args: --all-features -- -D warnings -W clippy::pedantic -W clippy::nursery -W rust-2018-idioms -A clippy::result_large_err
 
   test:
     name: Run Tests

src/config.rs

@@ -5,6 +5,9 @@ use serde::{Deserialize, Serialize};
 
 static OPENAPI_CONFIG: OnceLock<Option<OpenAPIConfig>> = OnceLock::new();
 
+/// # Errors
+///
+/// Will return `Err` if initializers: openapi: is not set in config/*.yaml
 pub fn set_openapi_config(ctx: &AppContext) -> Result<Option<&OpenAPIConfig>, Error> {
     let json = ctx
         .config

src/lib.rs

@@ -23,17 +23,16 @@ pub mod utils;
 type RouterList = Option<Vec<OpenApiRouter<AppContext>>>;
 type InitialSpec = dyn Fn(&AppContext) -> OpenApi + Send + Sync + 'static;
 
-/// Loco initializer for OpenAPI with custom initial spec setup
+/// Loco initializer for `OpenAPI` with custom initial spec setup
 #[derive(Default)]
 pub struct OpenapiInitializerWithSetup {
-    /// Custom setup for the initial OpenAPI spec, if any
+    /// Custom setup for the initial `OpenAPI` spec, if any
     initial_spec: Option<Box<InitialSpec>>,
-    /// Routes to add to the OpenAPI spec
+    /// Routes to add to the `OpenAPI` spec
     routes_setup: RouterList,
 }
 
 impl OpenapiInitializerWithSetup {
-    #[inline(always)]
     #[must_use]
     pub fn new<F>(initial_spec: F, routes_setup: RouterList) -> Self
     where
@@ -55,12 +54,12 @@ impl Initializer for OpenapiInitializerWithSetup {
     async fn after_routes(&self, mut router: AxumRouter, ctx: &AppContext) -> Result<AxumRouter> {
         set_openapi_config(ctx)?;
 
-        let mut api_router: OpenApiRouter<AppContext> =
-            if let Some(ref custom_spec_fn) = self.initial_spec {
+        let mut api_router: OpenApiRouter<AppContext> = self
+            .initial_spec
+            .as_ref()
+            .map_or_else(OpenApiRouter::new, |custom_spec_fn| {
                 OpenApiRouter::with_openapi(custom_spec_fn(ctx))
-            } else {
-                OpenApiRouter::new()
-            };
+            });
 
         // Merge all manually collected routes
         if let Some(ref routes_setup) = self.routes_setup {
@@ -72,17 +71,15 @@ impl Initializer for OpenapiInitializerWithSetup {
         // Merge all automatically collected routes
         api_router = api_router.merge(get_merged_router());
 
-        // Collect the OpenAPI spec
+        // Collect the `OpenAPI` spec
         let (_, open_api_spec) = api_router.split_for_parts();
         set_openapi_spec(open_api_spec);
 
-        let open_api_config = if let Some(open_api_config) = get_openapi_config() {
-            open_api_config
-        } else {
+        let Some(open_api_config) = get_openapi_config() else {
             return Ok(router);
         };
 
-        // Serve the OpenAPI spec using the enabled OpenAPI visualizers
+        // Serve the `OpenAPI` spec using the enabled `OpenAPI` visualizers
         #[cfg(feature = "redoc")]
         if let Some(OpenAPIType::Redoc {
             url,

src/openapi.rs

@@ -16,6 +16,7 @@ pub fn add_route(route: OpenApiRouter<AppContext>) {
 }
 
 // Get a merged router containing all collected routes
+#[must_use]
 pub fn get_merged_router() -> OpenApiRouter<AppContext> {
     let mut result = OpenApiRouter::new();
 

src/utils.rs

@@ -11,16 +11,27 @@ pub fn set_openapi_spec(api: OpenApi) -> &'static OpenApi {
     OPENAPI_SPEC.get_or_init(|| api)
 }
 
+/// # Panics
+///
+/// Will panic if `OpenAPI` spec fails to build
 pub fn get_openapi_spec() -> &'static OpenApi {
     OPENAPI_SPEC.get().unwrap()
 }
 
 /// Axum handler that returns the `OpenAPI` spec as JSON
+///
+/// # Errors
+/// Currently this function doesn't return any error. this is for feature
+/// functionality
 pub async fn openapi_spec_json() -> Result<Response> {
     format::json(get_openapi_spec())
 }
 
 /// Axum handler that returns the `OpenAPI` spec as YAML
+///
+/// # Errors
+/// Currently this function doesn't return any error. this is for feature
+/// functionality
 pub async fn openapi_spec_yaml() -> Result<Response> {
     format::yaml(&get_openapi_spec().to_yaml()?)
 }