Struct Ingredient 

pub struct Ingredient { /* private fields */ }

An Ingredient is any external asset that has been used in the creation of an asset.

Implementations

impl Ingredient

pub fn new<S>(title: S, format: S, instance_id: S) -> Self

where S: Into<String>,

Constructs a new Ingredient.

Arguments

• title - A user-displayable name for this ingredient (often a filename).
• format - The MIME media type of the ingredient, for example image/jpeg.
• instance_id - A unique identifier, such as the value of the ingredient’s xmpMM:InstanceID.

Example

use c2pa::Ingredient;
let ingredient = Ingredient::new("title", "image/jpeg", "ed610ae51f604002be3dbf0c589a2f1f");

pub fn new_v2<S1, S2>(title: S1, format: S2) -> Self

where S1: Into<String>, S2: Into<String>,

Constructs a new V2 Ingredient.

Arguments

• title - A user-displayable name for this ingredient (often a filename).
• format - The MIME media type of the ingredient, for example image/jpeg.

Example

use c2pa::Ingredient;
let ingredient = Ingredient::new_v2("title", "image/jpeg");

pub fn title(&self) -> Option<&str>

Returns a user-displayable title for this ingredient.

pub fn label(&self) -> Option<&str>

Returns the label for the ingredient if it exists.

pub fn format(&self) -> Option<&str>

Returns a MIME content_type for this asset associated with this ingredient.

pub fn document_id(&self) -> Option<&str>

Returns a document identifier if one exists.

pub fn instance_id(&self) -> &str

Returns the instance identifier.

For v2 ingredients this can return an empty string

pub fn effective_id(&self) -> String

Available on crate feature unstable_builder_filter only.

Returns the id used to reference this ingredient from a claim: its label when present and non-empty, otherwise its instance_id.

This is how the Builder keys ingredients when resolving action ingredientIds and emitting positional assertion labels, so any code matching actions to ingredients must use the same rule. It is public for exactly that reason: external code filtering or matching actions against ingredients (e.g. via Builder::filter_actions and Builder::filter_ingredients) must not reimplement (and risk diverging from) this rule.

Experimental. This method is available only with the unstable_builder_filter feature enabled. It is exempt from this crate’s usual semantic-versioning stability guarantees and may change in a backward-incompatible way, or be removed entirely, in any release.

pub fn provenance(&self) -> Option<&str>

Returns the provenance URI if available.

pub fn thumbnail_ref(&self) -> Option<&ResourceRef>

Returns a ResourceRef or None.

pub fn thumbnail(&self) -> Option<(&str, Cow<'_, Vec<u8>>)>

Returns thumbnail tuple Some((format, bytes)) or None.

pub fn thumbnail_bytes(&self) -> Result<Cow<'_, Vec<u8>>>

Returns a Cow of thumbnail bytes or Err(Error::NotFound)`.

pub fn hash(&self) -> Option<&str>

Returns an optional hash to uniquely identify this asset.

pub fn is_parent(&self) -> bool

Returns true if this is labeled as the parent ingredient.

pub fn relationship(&self) -> &Relationship

Returns the relationship status of the ingredient.

pub fn validation_status(&self) -> Option<&[ValidationStatus]>

Returns a reference to the [ValidationStatus]s if they exist.

pub fn validation_results(&self) -> Option<&ValidationResults>

Returns a reference to the ValidationResultss if they exist.

pub fn metadata(&self) -> Option<&AssertionMetadata>

Returns a reference to AssertionMetadata if it exists.

pub fn active_manifest(&self) -> Option<&str>

Returns the label for the active Manifest in this ingredient, if one exists.

If None, the ingredient has no Manifests.

pub fn manifest_data_ref(&self) -> Option<&ResourceRef>

Returns a reference to C2PA manifest data if it exists.

manifest_data is the binary form of a manifest store in .c2pa format.

pub fn manifest_data(&self) -> Option<Cow<'_, Vec<u8>>>

Returns a copy on write ref to the manifest data bytes or None`.

manifest_data is the binary form of a manifest store in .c2pa format.

pub fn data_ref(&self) -> Option<&ResourceRef>

Returns a reference to ingredient data if it exists.

pub fn description(&self) -> Option<&str>

Returns the detailed description of the ingredient if it exists.

pub fn informational_uri(&self) -> Option<&str>

Returns an informational uri for the ingredient if it exists.

pub fn data_types(&self) -> Option<&[AssetType]>

Returns an list AssetType info.

pub fn set_title<S: Into<String>>(&mut self, title: S) -> &mut Self

Sets a human-readable title for this ingredient.

pub fn set_instance_id<S: Into<String>>(&mut self, instance_id: S) -> &mut Self

Sets the document instanceId.

This call is optional for v2 ingredients.

Typically this is found in XMP under xmpMM:InstanceID.

pub fn set_document_id<S: Into<String>>(&mut self, document_id: S) -> &mut Self

Sets the document identifier.

This call is optional.

Typically this is found in XMP under xmpMM:DocumentID.

pub fn set_provenance<S: Into<String>>(&mut self, provenance: S) -> &mut Self

Sets the provenance URI.

This call is optional.

Typically this is found in XMP under dcterms:provenance.

pub fn set_is_parent(&mut self) -> &mut Self

Identifies this ingredient as the parent.

Only one ingredient should be flagged as a parent. Use Manifest.set_parent to ensure this is the only parent ingredient.

pub fn set_relationship(&mut self, relationship: Relationship) -> &mut Self

Set the ingredient Relationship status.

Only one ingredient should be set as a parentOf. Use Manifest.set_parent to ensure this is the only parent ingredient.

pub fn set_thumbnail_ref(&mut self, thumbnail: ResourceRef) -> Result<&mut Self>

Sets the thumbnail from a ResourceRef.

pub fn set_thumbnail<S: Into<String>, B: Into<Vec<u8>>>( &mut self, format: S, bytes: B, ) -> Result<&mut Self>

Sets the thumbnail format and image data.

pub fn set_hash<S: Into<String>>(&mut self, hash: S) -> &mut Self

Sets the hash value generated from the entire asset.

pub fn add_validation_status(&mut self, status: ValidationStatus) -> &mut Self

Adds a [ValidationStatus] to this ingredient.

pub fn set_metadata(&mut self, metadata: AssertionMetadata) -> &mut Self

Adds any desired AssertionMetadata to this ingredient.

pub fn set_active_manifest<S: Into<String>>(&mut self, label: S) -> &mut Self

Sets the label for the active manifest in the manifest data.

pub fn set_label<S: Into<String>>(&mut self, label: S) -> &mut Self

Sets the ingredient’s label, used as the linking key for action ingredientIds[].

pub fn set_manifest_data_ref( &mut self, data_ref: ResourceRef, ) -> Result<&mut Self>

Sets a reference to Manifest C2PA data.

pub fn set_manifest_data(&mut self, data: Vec<u8>) -> Result<&mut Self>

Sets the Manifest C2PA data for this ingredient with bytes.

pub fn set_data_ref(&mut self, data_ref: ResourceRef) -> Result<&mut Self>

Sets a reference to Ingredient data.

pub fn set_description<S: Into<String>>(&mut self, description: S) -> &mut Self

Sets a detailed description for this ingredient.

pub fn set_informational_uri<S: Into<String>>(&mut self, uri: S) -> &mut Self

Sets an informational URI if needed.

pub fn add_data_type(&mut self, data_type: AssetType) -> &mut Self

Add AssetType info for Ingredient.

pub fn from_file_info<P: AsRef<Path>>(path: P) -> Self

Available on crate feature file_io only.

Generates an Ingredient from a file path, including XMP info from the file if available.

This does not read c2pa_data in a file, it only reads XMP.

pub fn from_stream_info<F, S>( stream: &mut dyn CAIRead, format: F, title: S, ) -> Self

where F: Into<String>, S: Into<String>,

Generates an Ingredient from a stream, including XMP info.

pub fn from_stream(format: &str, stream: &mut dyn CAIRead) -> Result<Self>

👎Deprecated:

Use with_stream with an explicit Context instead

Creates an Ingredient from a stream using thread-local settings.

This does not set title or hash. Thumbnail will be set only if one can be retrieved from a previous valid manifest.

Pass an explicit Context via add_stream_internal instead.

pub fn from_json(json: &str) -> Result<Self>

Create an Ingredient from JSON.

pub async fn from_memory_async(format: &str, buffer: &[u8]) -> Result<Self>

👎Deprecated:

Use with_stream with an explicit Context instead of relying on thread-local settings.

Creates an Ingredient from a memory buffer (async version) using thread-local settings.

This does not set title or hash. Thumbnail will be set only if one can be retrieved from a previous valid manifest.

Use Builder::from_context with an explicit Context instead.

pub async fn from_stream_async( format: &str, stream: &mut dyn CAIRead, ) -> Result<Self>

👎Deprecated:

Use with_stream_async with an explicit Context instead of relying on thread-local settings.

Creates an Ingredient from a stream (async version) using thread-local settings.

This does not set title or hash. Thumbnail will be set only if one can be retrieved from a previous valid manifest.

Use Builder::from_context with an explicit Context instead.

pub async fn from_manifest_and_asset_bytes_async<M: Into<Vec<u8>>>( manifest_bytes: M, format: &str, asset_bytes: &[u8], ) -> Result<Self>

👎Deprecated:

Pass an explicit Context via from_manifest_and_asset_stream_async instead of relying on thread-local settings.

Asynchronously create an Ingredient from a binary manifest (.c2pa) and asset bytes, using thread-local settings.

Use Ingredient::from_manifest_and_asset_stream_async with an explicit Context instead.

Example: Create an Ingredient from a binary manifest (.c2pa) and asset bytes

use c2pa::{Result, Ingredient};

        let asset_bytes = include_bytes!("../tests/fixtures/cloud.jpg");
        let manifest_bytes = include_bytes!("../tests/fixtures/cloud_manifest.c2pa");

        let ingredient = Ingredient::from_manifest_and_asset_bytes_async(manifest_bytes.to_vec(), "image/jpeg", asset_bytes)
            .await
            .unwrap();

        println!("{}", ingredient);
}

pub async fn from_manifest_and_asset_stream_async<M: Into<Vec<u8>>>( manifest_bytes: M, format: &str, stream: &mut dyn CAIRead, ) -> Result<Self>

👎Deprecated:

Pass an explicit Context instead of relying on thread-local settings.

Asynchronously create an Ingredient from a binary manifest (.c2pa) and asset, using thread-local settings.

Pass an explicit Context instead of relying on thread-local settings.

Trait Implementations

impl Clone for Ingredient

fn clone(&self) -> Ingredient

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Ingredient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Ingredient

fn default() -> Ingredient

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Ingredient

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Ingredient

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl JsonSchema for Ingredient

Available on crate feature json_schema only.

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Serialize for Ingredient

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.