chore(client): restructure event module to avoid allowing clippy warnings

Author: Snapstromegon

src/event.rs

@@ -1,83 +1,14 @@
 //! This module holds all event types that are send between the client and the database.
 
-// Allow module inception here, since "event" is the expected as the name for both modules.
-// Renaming would be possible, but would probably lead to more confusion.
-#[allow(clippy::module_inception)]
-mod event;
-mod event_candidate;
-mod management_event;
+mod event_types;
+mod trace_info;
 
-pub use event::Event;
-pub use event_candidate::EventCandidate;
-pub use management_event::ManagementEvent;
-use serde::{Deserialize, Serialize};
+// Reexport relevant types to flatten the module graph for consumers and
+// keep private encapsulation of implementation details.
+pub use event_types::event::Event;
+pub use event_types::event_candidate::EventCandidate;
+pub use event_types::management_event::ManagementEvent;
+pub use trace_info::TraceInfo;
 
 #[cfg(feature="cloudevents")]
 use crate::error::EventError;
-
-/// Represents the trace information of an event.
-/// This is used for distributed tracing.
-/// It can either be a traceparent or a traceparent and tracestate.
-#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
-#[serde(untagged)]
-pub enum TraceInfo {
-    // LEAVE ORDER AS IS
-    // This is important for deserialization as the traceparent is always present
-
-    /// The traceparent and tracestate of the event.
-    /// This is used for distributed tracing.
-    WithState {
-        /// The traceparent of the event.
-        /// This is used for distributed tracing.
-        traceparent: String,
-        /// The tracestate of the event.
-        /// This is used for distributed tracing.
-        tracestate: String,
-    },
-    /// The traceparent of the event.
-    /// This is used for distributed tracing.
-    Traceparent {
-        /// The traceparent of the event.
-        /// This is used for distributed tracing.
-        traceparent: String,
-    },
-}
-
-impl TraceInfo {
-    /// Get the traceparent of the event.
-    #[must_use]
-    pub fn traceparent(&self) -> &str {
-        match self {
-            Self::Traceparent { traceparent } | Self::WithState { traceparent, .. } => traceparent,
-        }
-    }
-    /// Get the tracestate of the event.
-    #[must_use]
-    pub fn tracestate(&self) -> Option<&str> {
-        match self {
-            Self::Traceparent { .. } => None,
-            Self::WithState { tracestate, .. } => Some(tracestate),
-        }
-    }
-
-    /// Create a new `TraceInfo` from a cloudevent.
-    /// This will return None if the cloudevent does not contain a traceparent or tracestate.
-    ///
-    /// # Errors
-    /// If the cloudevent contains a tracestate but no traceparent, an error will be returned.
-    #[cfg(feature="cloudevents")]
-    pub fn from_cloudevent(event: &cloudevents::Event) -> Result<Option<Self>, EventError> {
-        let traceparent = event.extension("traceparent").map(ToString::to_string);
-        let tracestate = event.extension("tracestate").map(ToString::to_string);
-
-        match (traceparent, tracestate) {
-            (Some(traceparent), Some(tracestate)) => Ok(Some(Self::WithState {
-                traceparent,
-                tracestate,
-            })),
-            (Some(traceparent), None) => Ok(Some(Self::Traceparent { traceparent })),
-            (None, None) => Ok(None),
-            (None, Some(_)) => Err(EventError::InvalidCloudevent),
-        }
-    }
-}

src/event/event_types.rs

@@ -0,0 +1,5 @@
+//! This module holds all possible event types this sdk works with.
+
+pub mod event;
+pub mod event_candidate;
+pub mod management_event;

src/event/event.rs renamed to src/event/event_types/event.rs

@@ -2,7 +2,8 @@ use chrono::{DateTime, Utc};
 use serde::{Deserialize, Serialize};
 use serde_json::Value;
 
-use super::{EventCandidate, TraceInfo};
+use crate::event::{trace_info::TraceInfo, EventCandidate};
+
 
 /// Represents an event that has been received from the DB.
 #[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]

src/event/event_candidate.rs renamed to src/event/event_types/event_candidate.rs

@@ -1,8 +1,8 @@
 use serde::{Deserialize, Serialize};
 use serde_json::Value;
 use typed_builder::TypedBuilder;
+use crate::event::trace_info::TraceInfo;
 
-use super::TraceInfo;
 #[cfg(feature = "cloudevents")]
 use crate::error::EventError;
 

src/event/management_event.rs renamed to src/event/event_types/management_event.rs

@@ -0,0 +1,70 @@
+//! This module holds supporting traits for the "Tracing" feature of eventsourcingdb.
+
+use serde::{Deserialize, Serialize};
+
+/// Represents the trace information of an event.
+/// This is used for distributed tracing.
+/// It can either be a traceparent or a traceparent and tracestate.
+#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
+#[serde(untagged)]
+pub enum TraceInfo {
+    // LEAVE ORDER AS IS
+    // This is important for deserialization as the traceparent is always present
+
+    /// The traceparent and tracestate of the event.
+    /// This is used for distributed tracing.
+    WithState {
+        /// The traceparent of the event.
+        /// This is used for distributed tracing.
+        traceparent: String,
+        /// The tracestate of the event.
+        /// This is used for distributed tracing.
+        tracestate: String,
+    },
+    /// The traceparent of the event.
+    /// This is used for distributed tracing.
+    Traceparent {
+        /// The traceparent of the event.
+        /// This is used for distributed tracing.
+        traceparent: String,
+    },
+}
+
+impl TraceInfo {
+    /// Get the traceparent of the event.
+    #[must_use]
+    pub fn traceparent(&self) -> &str {
+        match self {
+            Self::Traceparent { traceparent } | Self::WithState { traceparent, .. } => traceparent,
+        }
+    }
+    /// Get the tracestate of the event.
+    #[must_use]
+    pub fn tracestate(&self) -> Option<&str> {
+        match self {
+            Self::Traceparent { .. } => None,
+            Self::WithState { tracestate, .. } => Some(tracestate),
+        }
+    }
+
+    /// Create a new `TraceInfo` from a cloudevent.
+    /// This will return None if the cloudevent does not contain a traceparent or tracestate.
+    ///
+    /// # Errors
+    /// If the cloudevent contains a tracestate but no traceparent, an error will be returned.
+    #[cfg(feature="cloudevents")]
+    pub fn from_cloudevent(event: &cloudevents::Event) -> Result<Option<Self>, EventError> {
+        let traceparent = event.extension("traceparent").map(ToString::to_string);
+        let tracestate = event.extension("tracestate").map(ToString::to_string);
+
+        match (traceparent, tracestate) {
+            (Some(traceparent), Some(tracestate)) => Ok(Some(Self::WithState {
+                traceparent,
+                tracestate,
+            })),
+            (Some(traceparent), None) => Ok(Some(Self::Traceparent { traceparent })),
+            (None, None) => Ok(None),
+            (None, Some(_)) => Err(EventError::InvalidCloudevent),
+        }
+    }
+}