Struct oci_spec::image::Config

pub struct Config { /* private fields */ }

The execution parameters which SHOULD be used as a base when running a container using the image.

Implementations

impl Config

pub fn user(&self) -> &Option<String>

The username or UID which is a platform-specific structure that allows specific control over which user the process run as. This acts as a default value to use when the value is not specified when creating a container. For Linux based systems, all of the following are valid: user, uid, user:group, uid:gid, uid:group, user:gid. If group/gid is not specified, the default group and supplementary groups of the given user/uid in /etc/passwd from the container are applied.

pub fn exposed_ports(&self) -> &Option<Vec<String>>

A set of ports to expose from a container running this image. Its keys can be in the format of: port/tcp, port/udp, port with the default protocol being tcp if not specified. These values act as defaults and are merged with any specified when creating a container.

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

Entries are in the format of VARNAME=VARVALUE. These values act as defaults and are merged with any specified when creating a container.

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

A list of arguments to use as the command to execute when the container starts. These values act as defaults and may be replaced by an entrypoint specified when creating a container.

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

Default arguments to the entrypoint of the container. These values act as defaults and may be replaced by any specified when creating a container. If an Entrypoint value is not specified, then the first entry of the Cmd array SHOULD be interpreted as the executable to run.

pub fn volumes(&self) -> &Option<Vec<String>>

A set of directories describing where the process is likely to write data specific to a container instance.

pub fn working_dir(&self) -> &Option<String>

Sets the current working directory of the entrypoint process in the container. This value acts as a default and may be replaced by a working directory specified when creating a container.

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

The field contains arbitrary metadata for the container. This property MUST use the annotation rules.

pub fn stop_signal(&self) -> &Option<String>

The field contains the system call signal that will be sent to the container to exit. The signal can be a signal name in the format SIGNAME, for instance SIGKILL or SIGRTMIN+3.

impl Config

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

The field contains arbitrary metadata for the container. This property MUST use the annotation rules.

impl Config

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

The username or UID which is a platform-specific structure that allows specific control over which user the process run as. This acts as a default value to use when the value is not specified when creating a container. For Linux based systems, all of the following are valid: user, uid, user:group, uid:gid, uid:group, user:gid. If group/gid is not specified, the default group and supplementary groups of the given user/uid in /etc/passwd from the container are applied.

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

A set of ports to expose from a container running this image. Its keys can be in the format of: port/tcp, port/udp, port with the default protocol being tcp if not specified. These values act as defaults and are merged with any specified when creating a container.

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

Entries are in the format of VARNAME=VARVALUE. These values act as defaults and are merged with any specified when creating a container.

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

A list of arguments to use as the command to execute when the container starts. These values act as defaults and may be replaced by an entrypoint specified when creating a container.

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

Default arguments to the entrypoint of the container. These values act as defaults and may be replaced by any specified when creating a container. If an Entrypoint value is not specified, then the first entry of the Cmd array SHOULD be interpreted as the executable to run.

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

A set of directories describing where the process is likely to write data specific to a container instance.

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

Sets the current working directory of the entrypoint process in the container. This value acts as a default and may be replaced by a working directory specified when creating a container.

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

The field contains arbitrary metadata for the container. This property MUST use the annotation rules.

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

The field contains the system call signal that will be sent to the container to exit. The signal can be a signal name in the format SIGNAME, for instance SIGKILL or SIGRTMIN+3.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Config

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

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

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 Config

impl StructuralPartialEq for Config