From 0ad67d7bcec651ad4be6ca1d6504ee42ac87d1d0 Mon Sep 17 00:00:00 2001 From: The Bearodactyl Date: Mon, 18 Aug 2025 21:51:53 -0500 Subject: [PATCH] rename `gen` to `generator` for edition 2025 compatibility --- README.md | 2 +- examples/custom_schema/src/error.rs | 2 +- examples/nested/src/error.rs | 2 +- examples/secure_request_guard/src/api_key.rs | 2 +- examples/secure_request_guard/src/cookies.rs | 2 +- examples/secure_request_guard/src/http_auth.rs | 2 +- examples/secure_request_guard/src/main.rs | 2 +- examples/secure_request_guard/src/oauth2.rs | 2 +- examples/secure_request_guard/src/open_id.rs | 2 +- okapi/CHANGELOG.md | 1 + rocket-okapi-codegen/src/lib.rs | 4 ++-- rocket-okapi-codegen/src/openapi_attr/mod.rs | 4 ++-- rocket-okapi-codegen/src/openapi_spec.rs | 2 +- rocket-okapi/CHANGELOG.md | 1 + rocket-okapi/src/{gen.rs => generator.rs} | 0 rocket-okapi/src/lib.rs | 2 +- rocket-okapi/src/request/from_data_impls.rs | 2 +- rocket-okapi/src/request/from_form_multi_param_impls.rs | 2 +- rocket-okapi/src/request/from_form_param_impls.rs | 2 +- rocket-okapi/src/request/from_param_impls.rs | 2 +- rocket-okapi/src/request/from_request_impls.rs | 2 +- rocket-okapi/src/request/from_segments_impls.rs | 2 +- rocket-okapi/src/request/mod.rs | 2 +- rocket-okapi/src/response/mod.rs | 2 +- rocket-okapi/src/response/responder_impls.rs | 2 +- rocket-okapi/tests/db_pool.rs | 2 +- 26 files changed, 27 insertions(+), 25 deletions(-) rename rocket-okapi/src/{gen.rs => generator.rs} (100%) diff --git a/README.md b/README.md index 1fedb48a..9136c9af 100644 --- a/README.md +++ b/README.md @@ -88,7 +88,7 @@ You can solve this by implementing it manually, like this: ```rust use rocket_okapi::request::{OpenApiFromRequest, RequestHeaderInput}; -use rocket_okapi::gen::OpenApiGenerator; +use rocket_okapi::generator::OpenApiGenerator; use rocket_sync_db_pools::{diesel, database}; #[database("sqlite_logs")] diff --git a/examples/custom_schema/src/error.rs b/examples/custom_schema/src/error.rs index 88a27472..9cdb8045 100644 --- a/examples/custom_schema/src/error.rs +++ b/examples/custom_schema/src/error.rs @@ -5,7 +5,7 @@ use rocket::{ }; use rocket_okapi::okapi::openapi3::Responses; use rocket_okapi::okapi::schemars::{self, Map}; -use rocket_okapi::{gen::OpenApiGenerator, response::OpenApiResponderInner, OpenApiError}; +use rocket_okapi::{generator::OpenApiGenerator, response::OpenApiResponderInner, OpenApiError}; /// Error messages returned to user #[derive(Debug, serde::Serialize, schemars::JsonSchema)] diff --git a/examples/nested/src/error.rs b/examples/nested/src/error.rs index 88a27472..9cdb8045 100644 --- a/examples/nested/src/error.rs +++ b/examples/nested/src/error.rs @@ -5,7 +5,7 @@ use rocket::{ }; use rocket_okapi::okapi::openapi3::Responses; use rocket_okapi::okapi::schemars::{self, Map}; -use rocket_okapi::{gen::OpenApiGenerator, response::OpenApiResponderInner, OpenApiError}; +use rocket_okapi::{generator::OpenApiGenerator, response::OpenApiResponderInner, OpenApiError}; /// Error messages returned to user #[derive(Debug, serde::Serialize, schemars::JsonSchema)] diff --git a/examples/secure_request_guard/src/api_key.rs b/examples/secure_request_guard/src/api_key.rs index 38b84ec2..f8d2dfc9 100644 --- a/examples/secure_request_guard/src/api_key.rs +++ b/examples/secure_request_guard/src/api_key.rs @@ -10,7 +10,7 @@ use rocket_okapi::okapi::openapi3::{ Object, Responses, SecurityRequirement, SecurityScheme, SecuritySchemeData, }; use rocket_okapi::{ - gen::OpenApiGenerator, + generator::OpenApiGenerator, openapi, request::{OpenApiFromRequest, RequestHeaderInput}, }; diff --git a/examples/secure_request_guard/src/cookies.rs b/examples/secure_request_guard/src/cookies.rs index c8c114aa..30927bf5 100644 --- a/examples/secure_request_guard/src/cookies.rs +++ b/examples/secure_request_guard/src/cookies.rs @@ -9,7 +9,7 @@ use rocket::{ }; use rocket_okapi::okapi::openapi3::{Object, Parameter, ParameterValue}; use rocket_okapi::{ - gen::OpenApiGenerator, + generator::OpenApiGenerator, openapi, request::{OpenApiFromRequest, RequestHeaderInput}, }; diff --git a/examples/secure_request_guard/src/http_auth.rs b/examples/secure_request_guard/src/http_auth.rs index 343ccdb1..fbd79635 100644 --- a/examples/secure_request_guard/src/http_auth.rs +++ b/examples/secure_request_guard/src/http_auth.rs @@ -10,7 +10,7 @@ use rocket_okapi::okapi::openapi3::{ Object, SecurityRequirement, SecurityScheme, SecuritySchemeData, }; use rocket_okapi::{ - gen::OpenApiGenerator, + generator::OpenApiGenerator, openapi, request::{OpenApiFromRequest, RequestHeaderInput}, }; diff --git a/examples/secure_request_guard/src/main.rs b/examples/secure_request_guard/src/main.rs index 70dee46f..6af795f0 100644 --- a/examples/secure_request_guard/src/main.rs +++ b/examples/secure_request_guard/src/main.rs @@ -1,7 +1,7 @@ use rocket::config::Config; use rocket::Request; use rocket::{catch, catchers, response, response::Responder, Response}; -use rocket_okapi::gen::OpenApiGenerator; +use rocket_okapi::generator::OpenApiGenerator; use rocket_okapi::okapi; use rocket_okapi::okapi::openapi3::{MediaType, Responses}; use rocket_okapi::okapi::schemars; diff --git a/examples/secure_request_guard/src/oauth2.rs b/examples/secure_request_guard/src/oauth2.rs index 27c1e527..47317059 100644 --- a/examples/secure_request_guard/src/oauth2.rs +++ b/examples/secure_request_guard/src/oauth2.rs @@ -10,7 +10,7 @@ use rocket_okapi::okapi::openapi3::{ OAuthFlows, Object, SecurityRequirement, SecurityScheme, SecuritySchemeData, }; use rocket_okapi::{ - gen::OpenApiGenerator, + generator::OpenApiGenerator, openapi, request::{OpenApiFromRequest, RequestHeaderInput}, }; diff --git a/examples/secure_request_guard/src/open_id.rs b/examples/secure_request_guard/src/open_id.rs index be61fe5c..07e038be 100644 --- a/examples/secure_request_guard/src/open_id.rs +++ b/examples/secure_request_guard/src/open_id.rs @@ -9,7 +9,7 @@ use rocket_okapi::okapi::openapi3::{ Object, SecurityRequirement, SecurityScheme, SecuritySchemeData, }; use rocket_okapi::{ - gen::OpenApiGenerator, + generator::OpenApiGenerator, openapi, request::{OpenApiFromRequest, RequestHeaderInput}, }; diff --git a/okapi/CHANGELOG.md b/okapi/CHANGELOG.md index 004d8c64..d347ef2e 100644 --- a/okapi/CHANGELOG.md +++ b/okapi/CHANGELOG.md @@ -7,6 +7,7 @@ This project follows the [Semantic Versioning standard](https://semver.org/). ### Added ### Changed +- Changed usages of the `gen` module to `generator` for Edition 2025 compatibility ### Deprecated diff --git a/rocket-okapi-codegen/src/lib.rs b/rocket-okapi-codegen/src/lib.rs index 31a3b7e9..97f84f80 100644 --- a/rocket-okapi-codegen/src/lib.rs +++ b/rocket-okapi-codegen/src/lib.rs @@ -101,7 +101,7 @@ pub fn openapi_spec(input: TokenStream) -> TokenStream { /// This code is equivalent to: /// ```rust,ignore /// use rocket_okapi::request::{OpenApiFromRequest, RequestHeaderInput}; -/// use rocket_okapi::gen::OpenApiGenerator; +/// use rocket_okapi::generator::OpenApiGenerator; /// /// pub struct MyStructName; /// @@ -125,7 +125,7 @@ pub fn open_api_from_request_derive(input: TokenStream) -> TokenStream { let gen = quote! { impl<'r> rocket_okapi::request::OpenApiFromRequest<'r> for #name { fn from_request_input( - _gen: &mut rocket_okapi::gen::OpenApiGenerator, + _gen: &mut rocket_okapi::generator::OpenApiGenerator, _name: String, _required: bool, ) -> rocket_okapi::Result { diff --git a/rocket-okapi-codegen/src/openapi_attr/mod.rs b/rocket-okapi-codegen/src/openapi_attr/mod.rs index 67d88fe0..ea4b76ab 100644 --- a/rocket-okapi-codegen/src/openapi_attr/mod.rs +++ b/rocket-okapi-codegen/src/openapi_attr/mod.rs @@ -68,7 +68,7 @@ fn create_empty_route_operation_fn(route_fn: ItemFn) -> TokenStream { TokenStream::from(quote! { #[doc(hidden)] pub fn #fn_name( - _gen: &mut ::rocket_okapi::gen::OpenApiGenerator, + _gen: &mut ::rocket_okapi::generator::OpenApiGenerator, _op_id: String, ) -> ::rocket_okapi::Result<()> { Ok(()) @@ -323,7 +323,7 @@ fn create_route_operation_fn( TokenStream::from(quote! { #[doc(hidden)] pub fn #fn_name( - gen: &mut ::rocket_okapi::gen::OpenApiGenerator, + gen: &mut ::rocket_okapi::generator::OpenApiGenerator, operation_id: String, ) -> ::rocket_okapi::Result<()> { let mut responses = <#return_type as ::rocket_okapi::response::OpenApiResponder>::responses(gen)?; diff --git a/rocket-okapi-codegen/src/openapi_spec.rs b/rocket-okapi-codegen/src/openapi_spec.rs index a12c3040..69915fc5 100644 --- a/rocket-okapi-codegen/src/openapi_spec.rs +++ b/rocket-okapi-codegen/src/openapi_spec.rs @@ -10,7 +10,7 @@ pub fn create_openapi_spec(routes: TokenStream) -> Result { let add_operations = create_add_operations(paths); Ok(quote! { |settings: &::rocket_okapi::settings::OpenApiSettings| -> ::rocket_okapi::okapi::openapi3::OpenApi { - let mut gen = ::rocket_okapi::gen::OpenApiGenerator::new(settings); + let mut gen = ::rocket_okapi::generator::OpenApiGenerator::new(settings); #add_operations let mut spec = gen.into_openapi(); let mut info = ::rocket_okapi::okapi::openapi3::Info { diff --git a/rocket-okapi/CHANGELOG.md b/rocket-okapi/CHANGELOG.md index 431db29d..3bb33883 100644 --- a/rocket-okapi/CHANGELOG.md +++ b/rocket-okapi/CHANGELOG.md @@ -7,6 +7,7 @@ This project follows the [Semantic Versioning standard](https://semver.org/). ### Added ### Changed +- Renamed `gen` module to `generator` for Edition 2025 compatibility ### Deprecated diff --git a/rocket-okapi/src/gen.rs b/rocket-okapi/src/generator.rs similarity index 100% rename from rocket-okapi/src/gen.rs rename to rocket-okapi/src/generator.rs diff --git a/rocket-okapi/src/lib.rs b/rocket-okapi/src/lib.rs index 2e7a625c..e2c95b22 100644 --- a/rocket-okapi/src/lib.rs +++ b/rocket-okapi/src/lib.rs @@ -78,7 +78,7 @@ mod error; /// Contains the `Generator` struct, which you can use to manually control the way a struct is /// represented in the documentation. -pub mod gen; +pub mod generator; /// Contains several `Rocket` `Handler`s, which are used for serving the json files and the swagger /// interface. pub mod handlers; diff --git a/rocket-okapi/src/request/from_data_impls.rs b/rocket-okapi/src/request/from_data_impls.rs index 308589d7..9ea06c06 100644 --- a/rocket-okapi/src/request/from_data_impls.rs +++ b/rocket-okapi/src/request/from_data_impls.rs @@ -1,5 +1,5 @@ use super::OpenApiFromData; -use crate::gen::OpenApiGenerator; +use crate::generator::OpenApiGenerator; use okapi::{ openapi3::{MediaType, RequestBody}, Map, diff --git a/rocket-okapi/src/request/from_form_multi_param_impls.rs b/rocket-okapi/src/request/from_form_multi_param_impls.rs index 9360b1ad..1bfc0e88 100644 --- a/rocket-okapi/src/request/from_form_multi_param_impls.rs +++ b/rocket-okapi/src/request/from_form_multi_param_impls.rs @@ -1,4 +1,4 @@ -use crate::gen::OpenApiGenerator; +use crate::generator::OpenApiGenerator; use okapi::openapi3::{Object, Parameter, ParameterValue}; use schemars::schema::{InstanceType, Schema, SchemaObject, SingleOrVec}; use schemars::JsonSchema; diff --git a/rocket-okapi/src/request/from_form_param_impls.rs b/rocket-okapi/src/request/from_form_param_impls.rs index e143e833..af49438a 100644 --- a/rocket-okapi/src/request/from_form_param_impls.rs +++ b/rocket-okapi/src/request/from_form_param_impls.rs @@ -2,7 +2,7 @@ //! use super::{get_nested_form_parameters, OpenApiFromForm, OpenApiFromFormField}; -use crate::gen::OpenApiGenerator; +use crate::generator::OpenApiGenerator; use okapi::openapi3::{Object, Parameter, ParameterValue}; use schemars::JsonSchema; diff --git a/rocket-okapi/src/request/from_param_impls.rs b/rocket-okapi/src/request/from_param_impls.rs index 354dc8a3..a7cf9bc2 100644 --- a/rocket-okapi/src/request/from_param_impls.rs +++ b/rocket-okapi/src/request/from_param_impls.rs @@ -2,7 +2,7 @@ //! use super::OpenApiFromParam; -use crate::gen::OpenApiGenerator; +use crate::generator::OpenApiGenerator; use okapi::openapi3::{Object, Parameter, ParameterValue}; use schemars::JsonSchema; diff --git a/rocket-okapi/src/request/from_request_impls.rs b/rocket-okapi/src/request/from_request_impls.rs index 89a8bad7..65d21d57 100644 --- a/rocket-okapi/src/request/from_request_impls.rs +++ b/rocket-okapi/src/request/from_request_impls.rs @@ -1,5 +1,5 @@ use super::{OpenApiFromRequest, RequestHeaderInput}; -use crate::gen::OpenApiGenerator; +use crate::generator::OpenApiGenerator; use okapi::openapi3::*; use std::result::Result as StdResult; diff --git a/rocket-okapi/src/request/from_segments_impls.rs b/rocket-okapi/src/request/from_segments_impls.rs index 42dd7397..20e30239 100644 --- a/rocket-okapi/src/request/from_segments_impls.rs +++ b/rocket-okapi/src/request/from_segments_impls.rs @@ -2,7 +2,7 @@ //! use super::OpenApiFromSegments; -use crate::gen::OpenApiGenerator; +use crate::generator::OpenApiGenerator; use okapi::openapi3::{Object, Parameter, ParameterValue}; use schemars::JsonSchema; diff --git a/rocket-okapi/src/request/mod.rs b/rocket-okapi/src/request/mod.rs index c3d783b5..f45c52d4 100644 --- a/rocket-okapi/src/request/mod.rs +++ b/rocket-okapi/src/request/mod.rs @@ -5,7 +5,7 @@ mod from_param_impls; mod from_request_impls; mod from_segments_impls; -use super::gen::OpenApiGenerator; +use super::generator::OpenApiGenerator; use super::Result; use okapi::openapi3::{Parameter, RequestBody, Responses, SecurityRequirement, SecurityScheme}; diff --git a/rocket-okapi/src/response/mod.rs b/rocket-okapi/src/response/mod.rs index fc8c911d..8ec81454 100644 --- a/rocket-okapi/src/response/mod.rs +++ b/rocket-okapi/src/response/mod.rs @@ -1,6 +1,6 @@ mod responder_impls; -use super::gen::OpenApiGenerator; +use super::generator::OpenApiGenerator; use super::Result; use okapi::openapi3::Responses; diff --git a/rocket-okapi/src/response/responder_impls.rs b/rocket-okapi/src/response/responder_impls.rs index d7e64b0f..8162feb5 100644 --- a/rocket-okapi/src/response/responder_impls.rs +++ b/rocket-okapi/src/response/responder_impls.rs @@ -1,6 +1,6 @@ use super::OpenApiResponderInner; use crate::{ - gen::OpenApiGenerator, + generator::OpenApiGenerator, util::{ add_default_response_code, add_schema_response, change_all_responses_to_default, ensure_status_code_exists, produce_any_responses, set_content_type, set_status_code, diff --git a/rocket-okapi/tests/db_pool.rs b/rocket-okapi/tests/db_pool.rs index 45a96322..6e89c772 100644 --- a/rocket-okapi/tests/db_pool.rs +++ b/rocket-okapi/tests/db_pool.rs @@ -1,6 +1,6 @@ //! This test should just compile. -use rocket_okapi::gen::OpenApiGenerator; +use rocket_okapi::generator::OpenApiGenerator; use rocket_okapi::request::{OpenApiFromRequest, RequestHeaderInput}; use rocket_sync_db_pools::{database, diesel};