Merge pull request #812 from uzyn/derive-debug

Implements fmt::Debug to pub structs

src/auth/jwt.rs

@@ -29,6 +29,7 @@ pub struct UserClaims {
 ///
 /// auth::jwt::JWT::new("PqRwLF2rhHe8J22oBeHy");
 /// ```
+#[derive(Debug)]
 pub struct JWT {
     secret: String,
     algorithm: Algorithm,

src/bgworker/pg.rs

@@ -327,6 +327,7 @@ pub async fn ping(pool: &PgPool) -> Result<()> {
     Ok(())
 }
 
+#[derive(Debug)]
 pub struct RunOpts {
     pub num_workers: u32,
     pub poll_interval_sec: u32,

src/bgworker/skq.rs

@@ -7,6 +7,7 @@ use bb8::Pool;
 use sidekiq::{Processor, ProcessorConfig, RedisConnectionManager};
 pub type RedisPool = Pool<RedisConnectionManager>;
 
+#[derive(Debug)]
 pub struct SidekiqBackgroundWorker<W, A> {
     pub inner: W, // Now we store the worker with its actual type instead of a trait object
     _phantom: PhantomData<A>,

src/boot.rs

@@ -27,6 +27,7 @@ use crate::{
 };
 
 /// Represents the application startup mode.
+#[derive(Debug)]
 pub enum StartMode {
     /// Run the application as a server only. when running web server only,
     /// workers job will not handle.
@@ -36,6 +37,7 @@ pub enum StartMode {
     /// Pulling job worker and execute them
     WorkerOnly,
 }
+
 pub struct BootResult {
     /// Application Context
     pub app_context: AppContext,
@@ -46,6 +48,7 @@ pub struct BootResult {
 }
 
 /// Configuration structure for serving an application.
+#[derive(Debug)]
 pub struct ServeParams {
     /// The port number on which the server will listen for incoming
     /// connections.

src/cache/drivers/inmem.rs

@@ -22,6 +22,7 @@ pub fn new() -> Box<dyn CacheDriver> {
 }
 
 /// Represents the in-memory cache driver.
+#[derive(Debug)]
 pub struct Inmem {
     cache: Cache<String, String>,
 }

src/cache/drivers/null.rs

@@ -10,6 +10,7 @@ use super::CacheDriver;
 use crate::cache::{CacheError, CacheResult};
 
 /// Represents the in-memory cache driver.
+#[derive(Debug)]
 pub struct Null {}
 
 /// Creates a new null cache instance

src/controller/app_routes.rs

@@ -29,6 +29,7 @@ pub struct AppRoutes {
     channels: Option<AppChannels>,
 }
 
+#[derive(Debug)]
 pub struct ListRoutes {
     pub uri: String,
     pub actions: Vec<axum::http::Method>,

src/controller/format.rs

@@ -186,6 +186,7 @@ where
     html(&views::template(template, data)?)
 }
 
+#[derive(Debug)]
 pub struct RenderBuilder {
     response: Builder,
 }

src/controller/middleware/_archive/content_etag.rs

@@ -14,7 +14,7 @@ use hyper::header::{ETAG, IF_NONE_MATCH};
 use sha2::{Digest, Sha256};
 use tower::{Layer, Service}; // Corrected import
 
-#[derive(Clone)]
+#[derive(Clone, Debug)]
 pub struct EtagLayer;
 
 impl EtagLayer {
@@ -30,7 +30,7 @@ impl<S> Layer<S> for EtagLayer {
     }
 }
 
-#[derive(Clone)]
+#[derive(Clone, Debug)]
 pub struct EtagMiddleware<S> {
     inner: S,
 }

src/controller/middleware/fallback.rs

@@ -11,6 +11,7 @@ use tower_http::services::ServeFile;
 
 use crate::{app::AppContext, controller::middleware::MiddlewareLayer, Result};
 
+#[derive(Debug)]
 pub struct StatusCodeWrapper(pub StatusCode);
 
 #[derive(Debug, Clone, Deserialize, Serialize)]

src/controller/middleware/logger.rs

@@ -25,7 +25,7 @@ pub struct Config {
 }
 
 /// [`Middleware`] struct responsible for logging HTTP requests.
-#[derive(Serialize)]
+#[derive(Serialize, Debug)]
 pub struct Middleware {
     config: Config,
     environment: Environment,

src/controller/middleware/powered_by.rs

@@ -18,6 +18,7 @@ lazy_static::lazy_static! {
 }
 
 /// [`Middleware`] struct responsible for managing the identifier value for the `X-Powered-By` header.
+#[derive(Debug)]
 pub struct Middleware {
     ident: Option<HeaderValue>,
 }

src/controller/middleware/remote_ip.rs

@@ -207,7 +207,7 @@ impl fmt::Display for RemoteIP {
     }
 }
 
-#[derive(Clone)]
+#[derive(Clone, Debug)]
 struct RemoteIPLayer {
     trusted_proxies: Option<Vec<IpNetwork>>,
 }
@@ -252,7 +252,7 @@ impl<S> Layer<S> for RemoteIPLayer {
 }
 
 /// Remote IP Detection Middleware
-#[derive(Clone)]
+#[derive(Clone, Debug)]
 #[must_use]
 pub struct RemoteIPMiddleware<S> {
     inner: S,

src/controller/middleware/secure_headers.rs

@@ -156,7 +156,7 @@ impl SecureHeader {
 
 /// The [`SecureHeaders`] layer which wraps around the service and injects
 /// security headers
-#[derive(Clone)]
+#[derive(Clone, Debug)]
 pub struct SecureHeaders {
     headers: Vec<(HeaderName, HeaderValue)>,
 }
@@ -187,7 +187,7 @@ impl<S> Layer<S> for SecureHeaders {
 }
 
 /// The secure headers middleware
-#[derive(Clone)]
+#[derive(Clone, Debug)]
 #[must_use]
 pub struct SecureHeadersMiddleware<S> {
     inner: S,

src/controller/routes.rs

@@ -5,14 +5,14 @@ use tower::{Layer, Service};
 
 use super::describe;
 use crate::app::AppContext;
-#[derive(Clone, Default)]
+#[derive(Clone, Default, Debug)]
 pub struct Routes {
     pub prefix: Option<String>,
     pub handlers: Vec<Handler>,
     // pub version: Option<String>,
 }
 
-#[derive(Clone, Default)]
+#[derive(Clone, Default, Debug)]
 pub struct Handler {
     pub uri: String,
     pub method: axum::routing::MethodRouter<AppContext>,

src/db.rs

@@ -32,7 +32,7 @@ lazy_static! {
     pub static ref EXTRACT_DB_NAME: Regex = Regex::new(r"/([^/]+)$").unwrap();
 }
 
-#[derive(Default, Clone)]
+#[derive(Default, Clone, Debug)]
 pub struct MultiDb {
     pub db: HashMap<String, DatabaseConnection>,
 }

src/doctor.rs

@@ -17,7 +17,7 @@ const QUEUE_CONN_FAILED: &str = "queue connection: failed";
 const QUEUE_NOT_CONFIGURED: &str = "queue not configured?";
 
 /// Represents different resources that can be checked.
-#[derive(PartialOrd, PartialEq, Eq, Ord)]
+#[derive(PartialOrd, PartialEq, Eq, Ord, Debug)]
 pub enum Resource {
     SeaOrmCLI,
     Database,

src/gen/mod.rs

@@ -121,6 +121,7 @@ impl FromStr for DeploymentKind {
     }
 }
 
+#[derive(Debug)]
 pub enum Component {
     #[cfg(feature = "with-db")]
     Model {

src/mailer/email_sender.rs

@@ -13,7 +13,7 @@ use crate::{config, errors::Error};
 
 /// An enumeration representing the possible transport methods for sending
 /// emails.
-#[derive(Clone)]
+#[derive(Clone, Debug)]
 pub enum EmailTransport {
     /// SMTP (Simple Mail Transfer Protocol) transport.
     Smtp(lettre::AsyncSmtpTransport<lettre::Tokio1Executor>),
@@ -23,7 +23,7 @@ pub enum EmailTransport {
 
 /// A structure representing the email sender, encapsulating the chosen
 /// transport method.
-#[derive(Clone)]
+#[derive(Clone, Debug)]
 pub struct EmailSender {
     pub transport: EmailTransport,
 }

src/mailer/mod.rs

@@ -51,7 +51,7 @@ pub struct Email {
 }
 
 /// The options struct for configuring the email sender.
-#[derive(Default)]
+#[derive(Default, Debug)]
 #[allow(clippy::module_name_repetitions)]
 pub struct MailerOpts {
     pub from: String,

src/model/query/dsl/date_range.rs

@@ -2,6 +2,8 @@ use chrono::NaiveDateTime;
 use sea_orm::ColumnTrait;
 
 use super::{with, ConditionBuilder};
+
+#[derive(Debug)]
 pub struct DateRangeBuilder<T: ColumnTrait> {
     col: T,
     condition_builder: ConditionBuilder,

src/model/query/dsl/mod.rs

@@ -8,6 +8,7 @@ mod date_range;
 
 // pub mod pagination;
 
+#[derive(Debug)]
 pub struct ConditionBuilder {
     condition: Condition,
 }

src/scheduler.rs

@@ -110,7 +110,7 @@ impl fmt::Display for Scheduler {
 }
 
 /// Representing the scheduler itself.
-#[derive(Clone)]
+#[derive(Clone, Debug)]
 pub struct Scheduler {
     pub jobs: HashMap<String, Job>,
     binary_path: PathBuf,
@@ -119,6 +119,7 @@ pub struct Scheduler {
 }
 
 /// Specification used to filter all scheduler job with the given Spec.
+#[derive(Debug)]
 pub struct Spec {
     pub name: Option<String>,
     pub tag: Option<String>,

src/storage/contents.rs

@@ -1,5 +1,6 @@
 use bytes::Bytes;
 
+#[derive(Debug)]
 pub struct Contents {
     data: Bytes,
 }

src/storage/drivers/aws.rs

@@ -13,6 +13,7 @@ use super::{object_store_adapter::ObjectStoreAdapter, StoreDriver};
 use crate::Result;
 
 /// A set of AWS security credentials
+#[derive(Debug)]
 pub struct Credential {
     /// `AWS_ACCESS_KEY_ID`
     pub key_id: String,

src/storage/drivers/mod.rs

@@ -14,6 +14,8 @@ pub mod null;
 pub mod object_store_adapter;
 
 use super::StorageResult;
+
+#[derive(Debug)]
 pub struct UploadResponse {
     pub e_tag: Option<String>,
     pub version: Option<String>,

src/storage/strategies/backup.rs

@@ -28,7 +28,7 @@ use bytes::Bytes;
 use crate::storage::{strategies::StorageStrategy, Storage, StorageError, StorageResult};
 
 /// Enum representing the failure mode for the [`BackupStrategy`].
-#[derive(Clone)]
+#[derive(Clone, Debug)]
 pub enum FailureMode {
     /// Fail if any secondary storage backend encounters an error.
     BackupAll,

src/storage/strategies/mirror.rs

@@ -27,7 +27,7 @@ use bytes::Bytes;
 use crate::storage::{strategies::StorageStrategy, Storage, StorageError, StorageResult};
 
 /// Enum representing the failure mode for the [`MirrorStrategy`].
-#[derive(Clone)]
+#[derive(Clone, Debug)]
 pub enum FailureMode {
     /// Fail if any secondary storage mirror encounters an error.
     MirrorAll,
@@ -36,7 +36,7 @@ pub enum FailureMode {
 }
 
 /// Represents the Mirror Strategy for storage operations.
-#[derive(Clone)]
+#[derive(Clone, Debug)]
 pub struct MirrorStrategy {
     /// The primary storage backend.
     pub primary: String,

src/task.rs

@@ -64,6 +64,7 @@ impl Vars {
 
 /// Information about a task, including its name and details.
 #[allow(clippy::module_name_repetitions)]
+#[derive(Debug)]
 pub struct TaskInfo {
     pub name: String,
     pub detail: String,

src/tests_cfg/db.rs

@@ -70,6 +70,7 @@ pub mod test_db {
     impl ActiveModelBehavior for ActiveModel {}
 }
 
+#[derive(Debug)]
 pub struct Migrator;
 
 #[async_trait::async_trait]
@@ -79,6 +80,7 @@ impl MigratorTrait for Migrator {
     }
 }
 
+#[derive(Debug)]
 pub struct AppHook;
 #[async_trait]
 impl Hooks for AppHook {

src/tests_cfg/task.rs

@@ -1,6 +1,8 @@
 use crate::prelude::*;
 
+#[derive(Debug)]
 pub struct Foo;
+
 #[async_trait]
 impl Task for Foo {
     fn task(&self) -> TaskInfo {
@@ -15,7 +17,9 @@ impl Task for Foo {
     }
 }
 
+#[derive(Debug)]
 pub struct ParseArgs;
+
 #[async_trait]
 impl Task for ParseArgs {
     fn task(&self) -> TaskInfo {

src/validation.rs

@@ -72,6 +72,7 @@ pub fn is_valid_email(email: &str) -> Result<(), ValidationError> {
 /// in the trait, we MUST use `DbErr`, so we need to "hide" a _representation_
 /// of the error in `DbErr::Custom`, so that it can be unpacked later down the
 /// stream, in the central error response handler.
+#[derive(Debug)]
 pub struct ModelValidationErrors(pub ValidationErrors);
 
 #[cfg(feature = "with-db")]