chore(stackable-versioned): Move K8s related error enums

Author: Techassi

crates/stackable-versioned/src/k8s.rs

@@ -1,12 +1,16 @@
 use std::collections::HashMap;
 
 use k8s_version::Version;
+#[cfg(doc)]
+use kube::core::conversion::ConversionReview;
 use schemars::schema::{InstanceType, Schema, SchemaObject, SingleOrVec};
+use snafu::Snafu;
 
 // NOTE (@Techassi): This struct represents a rough first draft of how tracking values across
 // CRD versions can be achieved. It is currently untested and unproven and might change down the
 // line. Currently, this struct is only generated by the macro but not actually used by any other
 // code. The tracking itself will be introduced in a follow-up PR.
+/// Contains changed values during upgrades and downgrades of CRDs.
 #[derive(Clone, Debug, serde::Deserialize, serde::Serialize, schemars::JsonSchema)]
 pub struct ChangedValues {
     /// List of values needed when downgrading to a particular version.
@@ -16,6 +20,7 @@ pub struct ChangedValues {
     pub upgrades: HashMap<Version, Vec<ChangedValue>>,
 }
 
+/// Contains a changed value for a single field of the CRD.
 #[derive(Clone, Debug, serde::Deserialize, serde::Serialize, schemars::JsonSchema)]
 pub struct ChangedValue {
     /// The name of the field of the custom resource this value is for.
@@ -40,3 +45,30 @@ fn raw_object_schema(_: &mut schemars::r#gen::SchemaGenerator) -> Schema {
         ..Default::default()
     })
 }
+
+/// This error indicates that parsing an object from a [`ConversionReview`] failed.
+#[derive(Debug, Snafu)]
+pub enum ParseObjectError {
+    #[snafu(display(r#"failed to find "apiVersion" field"#))]
+    FieldNotPresent,
+
+    #[snafu(display(r#"the "apiVersion" field is not a string"#))]
+    FieldNotStr,
+
+    #[snafu(display("encountered unknown object api version {api_version:?}"))]
+    UnknownApiVersion { api_version: String },
+
+    #[snafu(display("failed to deserialize object from json"))]
+    Deserialize { source: serde_json::Error },
+}
+
+/// This error indicates that converting an object from a [`ConversionReview`] to the desired
+/// version failed.
+#[derive(Debug, Snafu)]
+pub enum ConvertObjectError {
+    #[snafu(display("failed to parse object"))]
+    Parse { source: ParseObjectError },
+
+    #[snafu(display("failed to serialize object into json"))]
+    Serialize { source: serde_json::Error },
+}

crates/stackable-versioned/src/lib.rs

@@ -1,17 +1,14 @@
-//! This crate enables versioning of structs and enums through procedural
-//! macros.
+//! This crate enables versioning of structs and enums through procedural macros.
 //!
 //! Currently supported versioning schemes:
 //!
-//! - Kubernetes API versions (eg: `v1alpha1`, `v1beta1`, `v1`, `v2`), with
-//!   optional support for generating CRDs.
+//! - Kubernetes API versions (eg: `v1alpha1`, `v1beta1`, `v1`, `v2`), with optional support for
+//!   generating CRDs.
 //!
-//! Support will be extended to SemVer versions, as well as custom version
-//! formats in the future.
+//! Support will be extended to SemVer versions, as well as custom version formats in the future.
 //!
-//! See [`versioned`] for an in-depth usage guide and a list of supported
-//! parameters.
-use snafu::Snafu;
+//! See [`versioned`] for an in-depth usage guide and a list of supported arguments.
+
 // Re-exports
 pub use stackable_versioned_macros::versioned;
 
@@ -20,31 +17,3 @@ pub use stackable_versioned_macros::versioned;
 mod k8s;
 #[cfg(feature = "k8s")]
 pub use k8s::*;
-
-// Behind flux-converter feature
-// #[cfg(feature = "flux-converter")]
-// pub mod flux_converter;
-
-#[derive(Debug, Snafu)]
-pub enum ParseObjectError {
-    #[snafu(display(r#"failed to find "apiVersion" field"#))]
-    FieldNotPresent,
-
-    #[snafu(display(r#"the "apiVersion" field is not a string"#))]
-    FieldNotStr,
-
-    #[snafu(display("encountered unknown object api version {api_version:?}"))]
-    UnknownApiVersion { api_version: String },
-
-    #[snafu(display("failed to deserialize object from json"))]
-    Deserialize { source: serde_json::Error },
-}
-
-#[derive(Debug, Snafu)]
-pub enum ConvertObjectError {
-    #[snafu(display("failed to parse object"))]
-    Parse { source: ParseObjectError },
-
-    #[snafu(display("failed to serialize object into json"))]
-    Serialize { source: serde_json::Error },
-}