Struct oci_client::manifest::OciDescriptor

pub struct OciDescriptor {
    pub media_type: String,
    pub digest: String,
    pub size: i64,
    pub urls: Option<Vec<String>>,
    pub annotations: Option<BTreeMap<String, String>>,
}

The OCI descriptor is a generic object used to describe other objects.

It is defined in the OCI Image Specification:

Fields

media_type: String

The media type of this descriptor.

Layers, config, and manifests may all have descriptors. Each is differentiated by its mediaType.

This REQUIRED property contains the media type of the referenced content. Values MUST comply with RFC 6838, including the naming requirements in its section 4.2.

digest: String

The SHA 256 or 512 digest of the object this describes.

This REQUIRED property is the digest of the targeted content, conforming to the requirements outlined in Digests. Retrieved content SHOULD be verified against this digest when consumed via untrusted sources.

size: i64

The size, in bytes, of the object this describes.

This REQUIRED property specifies the size, in bytes, of the raw content. This property exists so that a client will have an expected size for the content before processing. If the length of the retrieved content does not match the specified length, the content SHOULD NOT be trusted.

urls: Option<Vec<String>>

This OPTIONAL property specifies a list of URIs from which this object MAY be downloaded. Each entry MUST conform to RFC 3986. Entries SHOULD use the http and https schemes, as defined in RFC 7230.

annotations: Option<BTreeMap<String, String>>

This OPTIONAL property contains arbitrary metadata for this descriptor. This OPTIONAL property MUST use the annotation rules. https://github.com/opencontainers/image-spec/blob/main/annotations.md#rules

Trait Implementations

impl AsLayerDescriptor for &OciDescriptor

fn as_layer_descriptor(&self) -> LayerDescriptor<'_>

Convert the type to a LayerDescriptor reference

impl Clone for OciDescriptor

fn clone(&self) -> OciDescriptor

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OciDescriptor

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

Formats the value using the given formatter.

impl Default for OciDescriptor

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for OciDescriptor

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OciDescriptor

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

Formats the value using the given formatter.

impl Serialize for OciDescriptor

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

where __S: Serializer,

Serialize this value into the given Serde serializer.