Struct oci_spec::image::ImageManifestBuilder

pub struct ImageManifestBuilder { /* private fields */ }

Builder for ImageManifest.

Implementations

impl ImageManifestBuilder

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. This MUST be set when config.mediaType is set to the empty value. If defined, the value MUST comply with RFC 6838, including the naming requirements in its section 4.2, and MAY be registered with IANA. Implementations storing or copying image manifests MUST NOT error on encountering an artifactType that is unknown to the implementation.

pub fn config<VALUE: Into<Descriptor>>(self, value: VALUE) -> Self

This REQUIRED property references a configuration object for a container, by digest. Beyond the descriptor requirements, the value has the following additional restrictions: The media type descriptor property has additional restrictions for config. Implementations MUST support at least the following media types:

• application/vnd.oci.image.config.v1+json

Manifests concerned with portability SHOULD use one of the above media types.

pub fn layers<VALUE: Into<Vec<Descriptor>>>(self, value: VALUE) -> Self

Each item in the array MUST be a descriptor. The array MUST have the base layer at index 0. Subsequent layers MUST then follow in stack order (i.e. from layers[0] to layers[len(layers)-1]). The final filesystem layout MUST match the result of applying the layers to an empty directory. The ownership, mode, and other attributes of the initial empty directory are unspecified.

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 manifest. This OPTIONAL property MUST use the annotation rules.

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

Builds a new ImageManifest.

Errors

If a required field has not been initialized.

Trait Implementations

impl Default for ImageManifestBuilder

fn default() -> Self

Returns the “default value” for a type.