Struct oci_spec::image::ImageIndexBuilder

pub struct ImageIndexBuilder { /* private fields */ }

Builder for ImageIndex.

Implementations

impl ImageIndexBuilder

pub fn schema_version<VALUE: Into<u32>>(self, value: VALUE) -> 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 media_type<VALUE: Into<MediaType>>(self, value: VALUE) -> 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 artifact_type<VALUE: Into<MediaType>>(self, value: VALUE) -> 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 manifests<VALUE: Into<Vec<Descriptor>>>(self, value: VALUE) -> 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 subject<VALUE: Into<Descriptor>>(self, value: VALUE) -> 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 annotations<VALUE: Into<HashMap<String, String>>>( self, value: VALUE ) -> Self

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

pub fn build(self) -> Result<ImageIndex, OciSpecError>

Builds a new ImageIndex.

Errors

If a required field has not been initialized.

Trait Implementations

impl Default for ImageIndexBuilder

fn default() -> Self

Returns the “default value” for a type.