Struct OciImageIndex

pub struct OciImageIndex {
    pub schema_version: u8,
    pub media_type: Option<String>,
    pub manifests: Vec<ImageIndexEntry>,
    pub annotations: Option<BTreeMap<String, String>>,
}

The image index is a higher-level manifest which points to specific image manifest.

It is part of the OCI specification, and is defined here:

Fields

schema_version: u8

This is a schema version.

The specification does not specify the width of this integer. However, the only version allowed by the specification is 2. So we have made this a u8.

media_type: Option<String>

This is an optional media type describing this manifest.

It is reserved for compatibility, but the specification does not seem to recommend setting it.

manifests: Vec<ImageIndexEntry>

This property contains a list of manifests for specific platforms. The spec says this field must be present but the value may be an empty array.

annotations: Option<BTreeMap<String, String>>

The annotations for this manifest

The specification says “If there are no annotations then this property MUST either be absent or be an empty map.” TO accomodate either, this is optional.

Trait Implementations

impl Clone for OciImageIndex

fn clone(&self) -> OciImageIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OciImageIndex

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for OciImageIndex

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for OciImageIndex

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

Formats the value using the given formatter.

impl From<OciImageIndex> for OciManifest

fn from(m: OciImageIndex) -> Self

Converts to this type from the input type.

impl Serialize for OciImageIndex

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

where __S: Serializer,

Serialize this value into the given Serde serializer.