Struct oci_spec::image::ImageIndex

pub struct ImageIndex { /* private fields */ }

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.

Implementations

impl ImageIndex

pub fn schema_version(&self) -> 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.

impl ImageIndex

pub fn media_type(&self) -> &Option<MediaType>

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.

pub fn artifact_type(&self) -> &Option<MediaType>

This OPTIONAL property contains the type of an artifact when the manifest is used for an artifact. If defined, the value MUST comply with RFC 6838, including the naming requirements in its section 4.2, and MAY be registered with IANA.

pub fn manifests(&self) -> &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.

pub fn subject(&self) -> &Option<Descriptor>

This OPTIONAL property specifies a descriptor of another manifest. This value, used by the referrers API, indicates a relationship to the specified manifest.

pub fn annotations(&self) -> &Option<HashMap<String, String>>

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

impl ImageIndex

pub fn set_schema_version(&mut self, val: u32) -> &mut Self

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.

pub fn set_media_type(&mut self, val: Option<MediaType>) -> &mut Self

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.

pub fn set_artifact_type(&mut self, val: Option<MediaType>) -> &mut Self

This OPTIONAL property contains the type of an artifact when the manifest is used for an artifact. If defined, the value MUST comply with RFC 6838, including the naming requirements in its section 4.2, and MAY be registered with IANA.

pub fn set_manifests(&mut self, val: Vec<Descriptor>) -> &mut Self

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.

pub fn set_subject(&mut self, val: Option<Descriptor>) -> &mut Self

This OPTIONAL property specifies a descriptor of another manifest. This value, used by the referrers API, indicates a relationship to the specified manifest.

pub fn set_annotations( &mut self, val: Option<HashMap<String, String>>, ) -> &mut Self

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

impl ImageIndex

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

Attempts to load an image index from a file.

Errors

This function will return an OciSpecError::Io if the file does not exist or an OciSpecError::SerDe if the image index cannot be deserialized.

Example

use oci_spec::image::ImageIndex;

let image_index = ImageIndex::from_file("index.json").unwrap();

pub fn from_reader<R: Read>(reader: R) -> Result<ImageIndex>

Attempts to load an image index from a stream.

Errors

This function will return an OciSpecError::SerDe if the index cannot be deserialized.

Example

use oci_spec::image::ImageIndex;
use std::fs::File;

let reader = File::open("index.json").unwrap();
let image_index = ImageIndex::from_reader(reader).unwrap();

pub fn to_file<P: AsRef<Path>>(&self, path: P) -> Result<()>

Attempts to write an image index to a file as JSON. If the file already exists, it will be overwritten.

Errors

This function will return an OciSpecError::SerDe if the image index cannot be serialized.

Example

use oci_spec::image::ImageIndex;

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

pub fn to_file_pretty<P: AsRef<Path>>(&self, path: P) -> Result<()>

Attempts to write an image index to a file as pretty printed JSON. If the file already exists, it will be overwritten.

Errors

This function will return an OciSpecError::SerDe if the image index cannot be serialized.

Example

use oci_spec::image::ImageIndex;

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

pub fn to_writer<W: Write>(&self, writer: &mut W) -> Result<()>

Attempts to write an image index to a stream as JSON.

Errors

This function will return an OciSpecError::SerDe if the image index cannot be serialized.

Example

use oci_spec::image::ImageIndex;

let image_index = ImageIndex::from_file("index.json").unwrap();
let mut writer = Vec::new();
image_index.to_writer(&mut writer);

pub fn to_writer_pretty<W: Write>(&self, writer: &mut W) -> Result<()>

Attempts to write an image index to a stream as pretty printed JSON.

Errors

This function will return an OciSpecError::SerDe if the image index cannot be serialized.

Example

use oci_spec::image::ImageIndex;

let image_index = ImageIndex::from_file("index.json").unwrap();
let mut writer = Vec::new();
image_index.to_writer_pretty(&mut writer);

pub fn to_string(&self) -> Result<String>

Attempts to write an image index to a string as JSON.

Errors

This function will return an OciSpecError::SerDe if the image configuration cannot be serialized.

Example

use oci_spec::image::ImageIndex;

let image_index = ImageIndex::from_file("index.json").unwrap();
let json_str = image_index.to_string().unwrap();

pub fn to_string_pretty(&self) -> Result<String>

Attempts to write an image index to a string as pretty printed JSON.

Errors

This function will return an OciSpecError::SerDe if the image configuration cannot be serialized.

Example

use oci_spec::image::ImageIndex;

let image_index = ImageIndex::from_file("index.json").unwrap();
let json_str = image_index.to_string_pretty().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 Display for ImageIndex

This ToString trait is automatically implemented for any type which implements the Display trait. As such, ToString shouldn’t be implemented directly: Display should be implemented instead, and you get the ToString implementation for free.

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

Formats the value using the given formatter.

impl PartialEq for ImageIndex

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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 StructuralPartialEq for ImageIndex