Struct oci_spec::image::ImageIndex

pub struct ImageIndex {
    pub schema_version: u32,
    pub media_type: Option<String>,
    pub manifests: Vec<Descriptor>,
    pub annotations: Option<HashMap<String, String>>,
}

The image index is a higher-level manifest which points to specific image manifests, ideal for one or more platforms. While the use of an image index is OPTIONAL for image providers, image consumers SHOULD be prepared to process them.

Fields

schema_version: u32

This REQUIRED property specifies the image manifest schema version. For this version of the specification, this MUST be 2 to ensure backward compatibility with older versions of Docker. The value of this field will not change. This field MAY be removed in a future version of the specification.

media_type: Option<String>

This property is reserved for use, to maintain compatibility. When used, this field contains the media type of this document, which differs from the descriptor use of mediaType.

manifests: Vec<Descriptor>

This REQUIRED property contains a list of manifests for specific platforms. While this property MUST be present, the size of the array MAY be zero.

annotations: Option<HashMap<String, String>>

This OPTIONAL property contains arbitrary metadata for the image index. This OPTIONAL property MUST use the annotation rules.

Implementations

impl ImageIndex

pub fn load<P: AsRef<Path>>(path: P) -> Result<ImageIndex>

Attempts to load an image index.

Errors

This function will return an OciSpecError::Io if the image index does not exist or an OciSpecError::SerDe if it is invalid.

Example

use oci_spec::image::ImageIndex;

let image_index = ImageIndex::load("my-index.json").unwrap();

Trait Implementations

impl Clone for ImageIndex

fn clone(&self) -> ImageIndex

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ImageIndex

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

Formats the value using the given formatter.

impl Default for ImageIndex

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ImageIndex

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<ImageIndex> for ImageIndex

fn eq(&self, other: &ImageIndex) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &ImageIndex) -> bool

This method tests for !=.

impl Serialize for ImageIndex

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

Serialize this value into the given Serde serializer.

impl Eq for ImageIndex

impl StructuralEq for ImageIndex

impl StructuralPartialEq for ImageIndex