Struct c2pa::Ingredient

pub struct Ingredient { /* private fields */ }

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

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 - i.e. image/jpeg.
• instance_id - A unique identifier, such as the value of the ingredient’s xmpMM:InstanceID.

Examples

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 - i.e. image/jpeg.

Examples

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

pub fn title(&self) -> &str

Returns a user-displayable title for this ingredient.

pub fn format(&self) -> &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 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 ValidationStatuss if they exist.

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

Returns a reference to Metadata 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 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_memory_thumbnail<S: Into<String>, B: Into<Vec<u8>>>( &mut self, format: S, bytes: B ) -> Result<&mut Self>

👎Deprecated since 0.28.0: Please use set_thumbnail instead

Sets the thumbnail format and image data only in memory

This is only used for internally generated thumbnails - when reading thumbnails from files, we don’t want to write these to file So this ensures they stay in memory unless written out.

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: Metadata) -> &mut Self

Adds any desired Metadata 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_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 resources(&self) -> &ResourceStore

Return an immutable reference to the ingredient resources

pub fn resources_mut(&mut self) -> &mut ResourceStore

Return an mutable reference to the ingredient resources

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_file<P: AsRef<Path>>(path: P) -> Result<Self>

Available on crate feature file_io only.

Creates an Ingredient from a file path.

pub fn from_file_with_folder<P: AsRef<Path>>(path: P, folder: P) -> Result<Self>

Available on crate feature file_io only.

Creates an Ingredient from a file path.

pub fn from_file_with_options<P: AsRef<Path>>( path: P, options: &dyn IngredientOptions ) -> Result<Self>

Available on crate feature file_io only.

Creates an Ingredient from a file path and options.

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

Creates an Ingredient from a memory buffer.

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

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

Creates an Ingredient from a stream.

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

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>

Creates an Ingredient from a memory buffer (async version).

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

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

Creates an Ingredient from a stream (async version).

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

pub fn with_base_path<P: AsRef<Path>>(&mut self, base_path: P) -> Result<&Self>

Available on crate feature file_io only.

Setting a base path will make the ingredient use resource files instead of memory buffers

The files will be relative to the given base path

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

Asynchronously create an Ingredient from a binary manifest (.c2pa) and asset bytes

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>

Asynchronously create an Ingredient from a binary manifest (.c2pa) and asset

Trait Implementations

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

fn schema_name() -> String

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(gen: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn is_referenceable() -> bool

Whether JSON Schemas generated for this type should be 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.