feat(rust/signed-doc): refactor metadata into a module

Author: saibatizoku

rust/signed_doc/examples/mk_signed_doc.rs

@@ -199,35 +199,35 @@ fn build_empty_cose_doc(doc_bytes: Vec<u8>, meta: &Metadata) -> coset::CoseSign
 
     protected_header.rest.push((
         coset::Label::Text("type".to_string()),
-        encode_cbor_uuid(&meta.r#type),
+        encode_cbor_uuid(&meta.doc_type()),
     ));
     protected_header.rest.push((
         coset::Label::Text("id".to_string()),
-        encode_cbor_uuid(&meta.id),
+        encode_cbor_uuid(&meta.doc_id()),
     ));
     protected_header.rest.push((
         coset::Label::Text("ver".to_string()),
-        encode_cbor_uuid(&meta.ver),
+        encode_cbor_uuid(&meta.doc_ver()),
     ));
-    if let Some(r#ref) = &meta.r#ref {
+    if let Some(r#ref) = &meta.doc_ref() {
         protected_header.rest.push((
             coset::Label::Text("ref".to_string()),
             encode_cbor_document_ref(r#ref),
         ));
     }
-    if let Some(template) = &meta.template {
+    if let Some(template) = &meta.doc_template() {
         protected_header.rest.push((
             coset::Label::Text("template".to_string()),
             encode_cbor_document_ref(template),
         ));
     }
-    if let Some(reply) = &meta.reply {
+    if let Some(reply) = &meta.doc_reply() {
         protected_header.rest.push((
             coset::Label::Text("reply".to_string()),
             encode_cbor_document_ref(reply),
         ));
     }
-    if let Some(section) = &meta.section {
+    if let Some(section) = &meta.doc_section() {
         protected_header.rest.push((
             coset::Label::Text("section".to_string()),
             coset::cbor::Value::Text(section.clone()),

rust/signed_doc/src/lib.rs

@@ -8,6 +8,10 @@ use std::{
 
 use coset::{CborSerializable, TaggedCborSerializable};
 
+mod metadata;
+
+pub use metadata::{DocumentRef, Metadata};
+
 /// Catalyst Signed Document Content Encoding Key.
 const CONTENT_ENCODING_KEY: &str = "content encoding";
 /// Catalyst Signed Document Content Encoding Value.
@@ -59,67 +63,6 @@ struct InnerCatalystSignedDocument {
     content_errors: Vec<String>,
 }
 
-/// Document Metadata.
-#[derive(Debug, serde::Deserialize)]
-pub struct Metadata {
-    /// Document Type `UUIDv7`.
-    pub r#type: uuid::Uuid,
-    /// Document ID `UUIDv7`.
-    pub id: uuid::Uuid,
-    /// Document Version `UUIDv7`.
-    pub ver: uuid::Uuid,
-    /// Reference to the latest document.
-    pub r#ref: Option<DocumentRef>,
-    /// Reference to the document template.
-    pub template: Option<DocumentRef>,
-    /// Reference to the document reply.
-    pub reply: Option<DocumentRef>,
-    /// Reference to the document section.
-    pub section: Option<String>,
-}
-
-impl Display for Metadata {
-    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), std::fmt::Error> {
-        writeln!(f, "Metadata {{")?;
-        writeln!(f, "  doc_type: {},", self.r#type)?;
-        writeln!(f, "  doc_id: {},", self.id)?;
-        writeln!(f, "  doc_ver: {},", self.ver)?;
-        writeln!(f, "  doc_ref: {:?},", self.r#ref)?;
-        writeln!(f, "  doc_template: {:?},", self.template)?;
-        writeln!(f, "  doc_reply: {:?},", self.reply)?;
-        writeln!(f, "  doc_section: {:?}", self.section)?;
-        writeln!(f, "}}")
-    }
-}
-
-impl Default for Metadata {
-    fn default() -> Self {
-        Self {
-            r#type: CatalystSignedDocument::INVALID_UUID,
-            id: CatalystSignedDocument::INVALID_UUID,
-            ver: CatalystSignedDocument::INVALID_UUID,
-            r#ref: None,
-            template: None,
-            reply: None,
-            section: None,
-        }
-    }
-}
-
-/// Reference to a Document.
-#[derive(Copy, Clone, Debug, serde::Deserialize)]
-#[serde(untagged)]
-pub enum DocumentRef {
-    /// Reference to the latest document
-    Latest {
-        /// Document ID UUID
-        id: uuid::Uuid,
-    },
-    /// Reference to the specific document version
-    /// Document ID UUID, Document Ver UUID
-    WithVer(uuid::Uuid, uuid::Uuid),
-}
-
 // Do this instead of `new`  if we are converting a single parameter into a struct/type we
 // should use either `From` or `TryFrom` and reserve `new` for cases where we need
 // multiple parameters to actually create the type.  This is much more elegant to use this
@@ -161,9 +104,6 @@ impl TryFrom<Vec<u8>> for CatalystSignedDocument {
 }
 
 impl CatalystSignedDocument {
-    /// Invalid Doc Type UUID
-    const INVALID_UUID: uuid::Uuid = uuid::Uuid::from_bytes([0x00; 16]);
-
     // A bunch of getters to access the contents, or reason through the document, such as.
 
     /// Are there any validation errors (as opposed to structural errors.
@@ -207,6 +147,12 @@ impl CatalystSignedDocument {
     pub fn doc_reply(&self) -> Option<DocumentRef> {
         self.inner.metadata.doc_reply()
     }
+
+    /// Return Document Reply `Option<DocumentRef>`.
+    #[must_use]
+    pub fn doc_section(&self) -> Option<String> {
+        self.inner.metadata.doc_section()
+    }
 }
 
 /// Generate the COSE protected header used by Catalyst Signed Document.

rust/signed_doc/src/metadata/document_ref.rs

@@ -0,0 +1,15 @@
+//! Catalyst Signed Document Metadata.
+
+/// Reference to a Document.
+#[derive(Copy, Clone, Debug, serde::Deserialize)]
+#[serde(untagged)]
+pub enum DocumentRef {
+    /// Reference to the latest document
+    Latest {
+        /// Document ID UUID
+        id: uuid::Uuid,
+    },
+    /// Reference to the specific document version
+    /// Document ID UUID, Document Ver UUID
+    WithVer(uuid::Uuid, uuid::Uuid),
+}

rust/signed_doc/src/metadata/mod.rs

@@ -0,0 +1,99 @@
+//! Catalyst Signed Document Metadata.
+use std::fmt::{Display, Formatter};
+
+mod document_ref;
+
+pub use document_ref::DocumentRef;
+
+/// Document Metadata.
+#[derive(Debug, serde::Deserialize)]
+pub struct Metadata {
+    /// Document Type `UUIDv7`.
+    pub(crate) r#type: uuid::Uuid,
+    /// Document ID `UUIDv7`.
+    pub(crate) id: uuid::Uuid,
+    /// Document Version `UUIDv7`.
+    pub(crate) ver: uuid::Uuid,
+    /// Reference to the latest document.
+    pub(crate) r#ref: Option<DocumentRef>,
+    /// Reference to the document template.
+    pub(crate) template: Option<DocumentRef>,
+    /// Reference to the document reply.
+    pub(crate) reply: Option<DocumentRef>,
+    /// Reference to the document section.
+    pub(crate) section: Option<String>,
+}
+
+impl Metadata {
+    /// Invalid Doc Type UUID
+    const INVALID_UUID: uuid::Uuid = uuid::Uuid::from_bytes([0x00; 16]);
+
+    /// Return Document Type `UUIDv4`.
+    #[must_use]
+    pub fn doc_type(&self) -> uuid::Uuid {
+        self.r#type
+    }
+
+    /// Return Document ID `UUIDv7`.
+    #[must_use]
+    pub fn doc_id(&self) -> uuid::Uuid {
+        self.id
+    }
+
+    /// Return Document Version `UUIDv7`.
+    #[must_use]
+    pub fn doc_ver(&self) -> uuid::Uuid {
+        self.ver
+    }
+
+    /// Return Last Document Reference `Option<DocumentRef>`.
+    #[must_use]
+    pub fn doc_ref(&self) -> Option<DocumentRef> {
+        self.r#ref
+    }
+
+    /// Return Document Template `Option<DocumentRef>`.
+    #[must_use]
+    pub fn doc_template(&self) -> Option<DocumentRef> {
+        self.template
+    }
+
+    /// Return Document Reply `Option<DocumentRef>`.
+    #[must_use]
+    pub fn doc_reply(&self) -> Option<DocumentRef> {
+        self.reply
+    }
+
+    /// Return Document Section `Option<String>`.
+    #[must_use]
+    pub fn doc_section(&self) -> Option<String> {
+        self.section.clone()
+    }
+}
+impl Display for Metadata {
+    fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), std::fmt::Error> {
+        writeln!(f, "Metadata {{")?;
+        writeln!(f, "  doc_type: {},", self.r#type)?;
+        writeln!(f, "  doc_id: {},", self.id)?;
+        writeln!(f, "  doc_ver: {},", self.ver)?;
+        writeln!(f, "  doc_ref: {:?},", self.r#ref)?;
+        writeln!(f, "  doc_template: {:?},", self.template)?;
+        writeln!(f, "  doc_reply: {:?},", self.reply)?;
+        writeln!(f, "  doc_section: {:?}", self.section)?;
+        writeln!(f, "}}")
+    }
+}
+
+impl Default for Metadata {
+    fn default() -> Self {
+        Self {
+            r#type: Self::INVALID_UUID,
+            id: Self::INVALID_UUID,
+            ver: Self::INVALID_UUID,
+            r#ref: None,
+            template: None,
+            reply: None,
+            section: None,
+        }
+    }
+}