refactor: Rename Metadata to AssertionMetadata (#1261)

Author: alextrnnn

sdk/src/assertions/actions.rs

@@ -19,7 +19,7 @@ use serde_cbor::Value;
 
 use crate::{
     assertion::{Assertion, AssertionBase, AssertionCbor},
-    assertions::{labels, region_of_interest::RegionOfInterest, Actor, Metadata},
+    assertions::{labels, region_of_interest::RegionOfInterest, Actor, AssertionMetadata},
     error::Result,
     resource_store::UriOrResource,
     utils::cbor_types::DateT,
@@ -521,7 +521,7 @@ pub struct Actions {
 
     /// Additional information about the assertion.
     #[serde(skip_serializing_if = "Option::is_none")]
-    pub metadata: Option<Metadata>,
+    pub metadata: Option<AssertionMetadata>,
 }
 
 impl Actions {
@@ -580,8 +580,8 @@ impl Actions {
         &mut self.actions
     }
 
-    /// Returns the assertion's [`Metadata`], if it exists.
-    pub fn metadata(&self) -> Option<&Metadata> {
+    /// Returns the assertion's [`AssertionMetadata`], if it exists.
+    pub fn metadata(&self) -> Option<&AssertionMetadata> {
         self.metadata.as_ref()
     }
 
@@ -597,8 +597,8 @@ impl Actions {
         self
     }
 
-    /// Sets [`Metadata`] for the action.
-    pub fn add_metadata(mut self, metadata: Metadata) -> Self {
+    /// Sets [`AssertionMetadata`] for the action.
+    pub fn add_metadata(mut self, metadata: AssertionMetadata) -> Self {
         self.metadata = Some(metadata);
         self
     }
@@ -657,7 +657,7 @@ pub mod tests {
     use crate::{
         assertion::AssertionData,
         assertions::{
-            metadata::{c2pa_source::GENERATOR_REE, DataSource, ReviewRating},
+            assertion_metadata::{c2pa_source::GENERATOR_REE, DataSource, ReviewRating},
             region_of_interest::{Range, RangeType, Time, TimeType},
         },
         hashed_uri::HashedUri,
@@ -723,7 +723,7 @@ pub mod tests {
                     }),
             )
             .add_metadata(
-                Metadata::new()
+                AssertionMetadata::new()
                     .add_review(ReviewRating::new("foo", Some("bar".to_owned()), 3))
                     .set_reference(make_hashed_uri1())
                     .set_data_source(DataSource::new(GENERATOR_REE)),

sdk/src/assertions/metadata.rs renamed to sdk/src/assertions/assertion_metadata.rs

@@ -26,10 +26,10 @@ use crate::{
 
 const ASSERTION_CREATION_VERSION: usize = 1;
 
-/// The Metadata structure can be used as part of other assertions or on its own to reference others
+/// The AssertionMetadata structure can be used as part of other assertions or on its own to reference others
 #[derive(Serialize, Deserialize, Clone, Debug, PartialEq)]
 #[cfg_attr(feature = "json_schema", derive(JsonSchema))]
-pub struct Metadata {
+pub struct AssertionMetadata {
     #[serde(rename = "reviewRatings", skip_serializing_if = "Option::is_none")]
     reviews: Option<Vec<ReviewRating>>,
     #[serde(rename = "dateTime", skip_serializing_if = "Option::is_none")]
@@ -42,7 +42,7 @@ pub struct Metadata {
     region_of_interest: Option<RegionOfInterest>,
 }
 
-impl Metadata {
+impl AssertionMetadata {
     /// Label prefix for an assertion metadata assertion.
     ///
     /// See <https://c2pa.org/specifications/specifications/2.2/specs/C2PA_Specification.html#_metadata_about_assertions>.
@@ -123,21 +123,21 @@ impl Metadata {
     }
 }
 
-impl Default for Metadata {
+impl Default for AssertionMetadata {
     fn default() -> Self {
         Self::new()
     }
 }
 
-impl std::fmt::Display for Metadata {
+impl std::fmt::Display for AssertionMetadata {
     fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
         f.write_str(&serde_json::to_string_pretty(self).unwrap_or_default())
     }
 }
 
-impl AssertionCbor for Metadata {}
+impl AssertionCbor for AssertionMetadata {}
 
-impl AssertionBase for Metadata {
+impl AssertionBase for AssertionMetadata {
     const LABEL: &'static str = Self::LABEL;
     const VERSION: Option<usize> = Some(ASSERTION_CREATION_VERSION);
 
@@ -312,26 +312,25 @@ pub mod tests {
     #[test]
     fn assertion_metadata() {
         let review = ReviewRating::new("foo", Some("bar".to_owned()), 3);
-        let original =
-            Metadata::new()
-                .add_review(review)
-                .set_region_of_interest(RegionOfInterest {
-                    region: vec![Range {
-                        range_type: RangeType::Temporal,
-                        time: Some(Time {
-                            time_type: TimeType::Npt,
-                            start: None,
-                            end: None,
-                        }),
-                        ..Default::default()
-                    }],
+        let original = AssertionMetadata::new()
+            .add_review(review)
+            .set_region_of_interest(RegionOfInterest {
+                region: vec![Range {
+                    range_type: RangeType::Temporal,
+                    time: Some(Time {
+                        time_type: TimeType::Npt,
+                        start: None,
+                        end: None,
+                    }),
                     ..Default::default()
-                });
+                }],
+                ..Default::default()
+            });
         println!("{:}", &original);
         let assertion = original.to_assertion().expect("build_assertion");
         assert_eq!(assertion.mime_type(), "application/cbor");
-        assert_eq!(assertion.label(), Metadata::LABEL);
-        let result = Metadata::from_assertion(&assertion).expect("extract_assertion");
+        assert_eq!(assertion.label(), AssertionMetadata::LABEL);
+        let result = AssertionMetadata::from_assertion(&assertion).expect("extract_assertion");
         println!("{:?}", serde_json::to_string(&result));
         assert_eq!(original.date_time, result.date_time);
         assert_eq!(original.reviews, result.reviews);

sdk/src/assertions/asset_types.rs

@@ -15,7 +15,7 @@
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 
-use super::{labels, AssetType, Metadata};
+use super::{labels, AssertionMetadata, AssetType};
 use crate::{
     assertion::{Assertion, AssertionBase, AssertionCbor},
     error::Result,
@@ -101,7 +101,7 @@ const ASSERTION_CREATION_VERSION: usize = 1;
 #[cfg_attr(feature = "json_schema", derive(JsonSchema))]
 pub struct AssetTypes {
     types: Vec<AssetType>,
-    metadata: Option<Metadata>,
+    metadata: Option<AssertionMetadata>,
 }
 
 #[allow(dead_code)]
@@ -125,12 +125,12 @@ impl AssetTypes {
         &self.types
     }
 
-    pub fn set_metadata(mut self, md: Metadata) -> Self {
+    pub fn set_metadata(mut self, md: AssertionMetadata) -> Self {
         self.metadata = Some(md);
         self
     }
 
-    pub fn metadata(&self) -> Option<&Metadata> {
+    pub fn metadata(&self) -> Option<&AssertionMetadata> {
         self.metadata.as_ref()
     }
 }

sdk/src/assertions/ingredient.rs

@@ -18,7 +18,7 @@ use serde::{ser::SerializeStruct, Deserialize, Serialize, Serializer};
 use super::AssetType;
 use crate::{
     assertion::{Assertion, AssertionBase, AssertionDecodeError, AssertionDecodeErrorCause},
-    assertions::{labels, Metadata, ReviewRating},
+    assertions::{labels, AssertionMetadata, ReviewRating},
     cbor_types::map_cbor_to_type,
     error::Result,
     hashed_uri::HashedUri,
@@ -56,7 +56,7 @@ pub struct Ingredient {
     pub validation_status: Option<Vec<ValidationStatus>>,
     pub relationship: Relationship,
     pub thumbnail: Option<HashedUri>,
-    pub metadata: Option<Metadata>,
+    pub metadata: Option<AssertionMetadata>,
     pub data: Option<HashedUri>,
     pub description: Option<String>,
     pub informational_uri: Option<String>,
@@ -220,7 +220,7 @@ impl Ingredient {
 
     pub fn add_reviews(mut self, reviews: Option<Vec<ReviewRating>>) -> Self {
         if let Some(reviews) = reviews {
-            let metadata = Metadata::new().set_reviews(reviews);
+            let metadata = AssertionMetadata::new().set_reviews(reviews);
             self.metadata = Some(metadata);
         };
         self
@@ -641,7 +641,8 @@ impl AssertionBase for Ingredient {
                 let thumbnail: Option<HashedUri> = map_cbor_to_type("thumbnail", &ingredient_value);
                 let validation_status: Option<Vec<ValidationStatus>> =
                     map_cbor_to_type("validationStatus", &ingredient_value);
-                let metadata: Option<Metadata> = map_cbor_to_type("metadata", &ingredient_value);
+                let metadata: Option<AssertionMetadata> =
+                    map_cbor_to_type("metadata", &ingredient_value);
 
                 Ingredient {
                     title: Some(title),
@@ -707,7 +708,8 @@ impl AssertionBase for Ingredient {
                     map_cbor_to_type("description", &ingredient_value);
                 let informational_uri: Option<String> =
                     map_cbor_to_type("informational_URI", &ingredient_value);
-                let metadata: Option<Metadata> = map_cbor_to_type("metadata", &ingredient_value);
+                let metadata: Option<AssertionMetadata> =
+                    map_cbor_to_type("metadata", &ingredient_value);
 
                 Ingredient {
                     title: Some(title),
@@ -774,7 +776,8 @@ impl AssertionBase for Ingredient {
                     map_cbor_to_type("description", &ingredient_value);
                 let informational_uri: Option<String> =
                     map_cbor_to_type("informationalURI", &ingredient_value);
-                let metadata: Option<Metadata> = map_cbor_to_type("metadata", &ingredient_value);
+                let metadata: Option<AssertionMetadata> =
+                    map_cbor_to_type("metadata", &ingredient_value);
 
                 Ingredient {
                     title,
@@ -972,7 +975,7 @@ pub mod tests {
 
         let review_rating = ReviewRating::new("Content bindings validated", None, 5);
 
-        let metadata = Metadata::new()
+        let metadata = AssertionMetadata::new()
             .set_date_time("2021-06-28T16:49:32.874Z".to_owned())
             .add_review(review_rating);
 

sdk/src/assertions/mod.rs

@@ -47,9 +47,9 @@ pub use ingredient::Relationship;
 
 pub mod labels;
 
-mod metadata;
-pub use metadata::{
-    c2pa_source, Actor, AssetType, DataBox, DataSource, Metadata, ReviewCode, ReviewRating,
+mod assertion_metadata;
+pub use assertion_metadata::{
+    c2pa_source, Actor, AssertionMetadata, AssetType, DataBox, DataSource, ReviewCode, ReviewRating,
 };
 
 mod schema_org;

sdk/src/assertions/region_of_interest.rs

@@ -1,12 +1,12 @@
 //! A set of structs to define a region of interest within an
-//! [`Action`][crate::assertions::Action] or [`Metadata`].
+//! [`Action`][crate::assertions::Action] or [`AssertionMetadata`].
 
 #[cfg(feature = "json_schema")]
 use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 use serde_with::skip_serializing_none;
 
-use super::Metadata;
+use super::AssertionMetadata;
 
 /// An x, y coordinate used for specifying vertices in polygons.
 #[derive(Debug, Clone, PartialEq, Serialize, Deserialize)]
@@ -234,7 +234,7 @@ pub enum Role {
 /// A region of interest within an asset describing the change.
 ///
 /// This struct can be used from [`Action::changes`][crate::assertions::Action::changes] or
-/// [`Metadata::region_of_interest`][crate::assertions::Metadata::region_of_interest].
+/// [`AssertionMetadata::region_of_interest`][crate::assertions::AssertionMetadata::region_of_interest].
 #[skip_serializing_none]
 #[derive(Debug, Default, Clone, PartialEq, Serialize, Deserialize)]
 #[cfg_attr(feature = "json_schema", derive(JsonSchema))]
@@ -259,5 +259,5 @@ pub struct RegionOfInterest {
     // If we didn't have a box, `Metadata` would recursively use `RegionOfInterest` causing an infinite size error.
     //
     /// Additional information about the asset.
-    pub metadata: Option<Box<Metadata>>,
+    pub metadata: Option<Box<AssertionMetadata>>,
 }

sdk/src/builder.rs

@@ -29,8 +29,8 @@ use zip::{write::SimpleFileOptions, ZipArchive, ZipWriter};
 use crate::{
     assertion::AssertionDecodeError,
     assertions::{
-        c2pa_action, labels, Action, ActionTemplate, Actions, BmffHash, BoxHash, CreativeWork,
-        DataHash, EmbeddedData, Exif, Metadata, SoftwareAgent, Thumbnail, User, UserCbor,
+        c2pa_action, labels, Action, ActionTemplate, Actions, AssertionMetadata, BmffHash, BoxHash,
+        CreativeWork, DataHash, EmbeddedData, Exif, SoftwareAgent, Thumbnail, User, UserCbor,
     },
     cbor_types::value_cbor_to_type,
     claim::Claim,
@@ -70,7 +70,7 @@ pub struct ManifestDefinition {
     pub claim_generator_info: Vec<ClaimGeneratorInfo>,
 
     /// Optional manifest metadata. This will be deprecated in the future; not recommended to use.
-    pub metadata: Option<Vec<Metadata>>,
+    pub metadata: Option<Vec<AssertionMetadata>>,
 
     /// A human-readable title, generally source filename.
     pub title: Option<String>,

sdk/src/claim.rs

@@ -32,7 +32,7 @@ use crate::{
     assertions::{
         self, c2pa_action,
         labels::{self, ACTIONS, ASSERTION_STORE, BMFF_HASH, CLAIM_THUMBNAIL, DATABOX_STORE},
-        Actions, AssetType, BmffHash, BoxHash, DataBox, DataHash, Ingredient, Metadata,
+        Actions, AssertionMetadata, AssetType, BmffHash, BoxHash, DataBox, DataHash, Ingredient,
         Relationship, V2_DEPRECATED_ACTIONS,
     },
     asset_io::CAIRead,
@@ -308,7 +308,7 @@ pub struct Claim {
 
     claim_generator_hints: Option<HashMap<String, Value>>,
 
-    metadata: Option<Vec<Metadata>>,
+    metadata: Option<Vec<AssertionMetadata>>,
 
     data_boxes: Vec<(HashedUri, DataBox)>, /* list of the data boxes and their hashed URIs found for this manifest */
 
@@ -622,7 +622,8 @@ impl Claim {
                 map_cbor_to_type(REDACTED_ASSERTIONS_F, &claim_value);
             let alg: Option<String> = map_cbor_to_type(ALG_F, &claim_value);
             let alg_soft: Option<String> = map_cbor_to_type(ALG_SOFT_F, &claim_value);
-            let metadata: Option<Vec<Metadata>> = map_cbor_to_type(METADATA_F, &claim_value);
+            let metadata: Option<Vec<AssertionMetadata>> =
+                map_cbor_to_type(METADATA_F, &claim_value);
 
             Ok(Claim {
                 remote_manifest: RemoteManifest::NoRemote,
@@ -710,7 +711,8 @@ impl Claim {
                 map_cbor_to_type(REDACTED_ASSERTIONS_F, &claim_value);
             let alg: Option<String> = map_cbor_to_type(ALG_F, &claim_value);
             let alg_soft: Option<String> = map_cbor_to_type(ALG_SOFT_F, &claim_value);
-            let metadata: Option<Vec<Metadata>> = map_cbor_to_type(METADATA_F, &claim_value);
+            let metadata: Option<Vec<AssertionMetadata>> =
+                map_cbor_to_type(METADATA_F, &claim_value);
 
             // create merged list of created and gathered assertions for processing compatibility
             // created are added first with highest priority than gathered
@@ -1135,15 +1137,15 @@ impl Claim {
         self.claim_generator_info.as_deref()
     }
 
-    pub fn add_claim_metadata(&mut self, md: Metadata) -> &mut Self {
+    pub fn add_claim_metadata(&mut self, md: AssertionMetadata) -> &mut Self {
         match self.metadata.as_mut() {
             Some(md_vec) => md_vec.push(md),
             None => self.metadata = Some([md].to_vec()),
         }
         self
     }
 
-    pub fn metadata(&self) -> Option<&[Metadata]> {
+    pub fn metadata(&self) -> Option<&[AssertionMetadata]> {
         self.metadata.as_deref()
     }