Struct ImageConfig 

pub struct ImageConfig {
    pub architecture: String,
    pub os: String,
    pub os_version: Option<String>,
    pub os_features: Vec<String>,
    pub variant: Option<String>,
    pub config: Option<ContainerConfig>,
    pub rootfs: RootFs,
    pub history: Vec<History>,
    pub created: Option<String>,
    pub author: Option<String>,
}

OCI image configuration.

This contains the execution parameters for the container, along with the history and layer diff IDs.

Fields

architecture: String

The CPU architecture.

os: String

The operating system.

os_version: Option<String>

Optional OS version.

os_features: Vec<String>

Optional OS features required by the image.

variant: Option<String>

Optional architecture variant.

config: Option<ContainerConfig>

Container runtime configuration.

rootfs: RootFs

Layer content hashes (uncompressed).

history: Vec<History>

Build history.

created: Option<String>

Creation timestamp (RFC 3339).

author: Option<String>

Author of the image.

Implementations

impl ImageConfig

pub fn new(architecture: impl Into<String>, os: impl Into<String>) -> Self

Creates a new image config with the given architecture and OS.

pub fn from_bytes(data: &[u8]) -> Result<Self>

Parses an image config from JSON bytes.

pub fn to_bytes(&self) -> Result<Vec<u8>>

Serializes the config to canonical JSON bytes.

pub fn digest(&self) -> Result<Digest>

Computes the digest of this config.

pub fn validate(&self) -> Result<()>

Validates the image config for strict OCI requirements.

This currently checks:

• rootfs.type is “layers”

pub fn size(&self) -> Result<u64>

Returns the size of the serialized config.

pub fn with_layer(self, diff_id: Digest) -> Self

Adds a layer diff ID.

pub fn with_config(self, config: ContainerConfig) -> Self

Sets the container configuration.

pub fn with_history(self, history: History) -> Self

Adds a history entry.

pub fn labels(&self) -> Option<&BTreeMap<String, String>>

Returns the labels from the container config, if any.

pub fn entrypoint(&self) -> Option<&[String]>

Returns the entrypoint from the container config, if any.

pub fn cmd(&self) -> Option<&[String]>

Returns the cmd from the container config, if any.

pub fn env(&self) -> Option<&[String]>

Returns the environment variables from the container config, if any.

Trait Implementations

impl Clone for ImageConfig

fn clone(&self) -> ImageConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImageConfig

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ImageConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ImageConfig

fn eq(&self, other: &ImageConfig) -> 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 ImageConfig

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 ImageConfig

impl StructuralPartialEq for ImageConfig