Struct ImageConfig

Source
pub struct ImageConfig {
Show 25 fields pub hostname: Option<String>, pub domainname: Option<String>, pub user: Option<String>, pub attach_stdin: Option<bool>, pub attach_stdout: Option<bool>, pub attach_stderr: Option<bool>, pub exposed_ports: Option<HashMap<String, HashMap<(), ()>>>, pub tty: Option<bool>, pub open_stdin: Option<bool>, pub stdin_once: Option<bool>, pub env: Option<Vec<String>>, pub cmd: Option<Vec<String>>, pub healthcheck: Option<HealthConfig>, pub args_escaped: Option<bool>, pub image: Option<String>, pub volumes: Option<HashMap<String, HashMap<(), ()>>>, pub working_dir: Option<String>, pub entrypoint: Option<Vec<String>>, pub network_disabled: Option<bool>, pub mac_address: Option<String>, pub on_build: Option<Vec<String>>, pub labels: Option<HashMap<String, String>>, pub stop_signal: Option<String>, pub stop_timeout: Option<i64>, pub shell: Option<Vec<String>>,
}
Expand description

Configuration of the image. These fields are used as defaults when starting a container from the image.

Fields§

§hostname: Option<String>

The hostname to use for the container, as a valid RFC 1123 hostname.


> Deprecated: this field is not part of the image specification and is > always empty. It must not be used, and will be removed in API v1.48.

§domainname: Option<String>

The domain name to use for the container.


> Deprecated: this field is not part of the image specification and is > always empty. It must not be used, and will be removed in API v1.48.

§user: Option<String>

The user that commands are run as inside the container.

§attach_stdin: Option<bool>

Whether to attach to stdin.


> Deprecated: this field is not part of the image specification and is > always false. It must not be used, and will be removed in API v1.48.

§attach_stdout: Option<bool>

Whether to attach to stdout.


> Deprecated: this field is not part of the image specification and is > always false. It must not be used, and will be removed in API v1.48.

§attach_stderr: Option<bool>

Whether to attach to stderr.


> Deprecated: this field is not part of the image specification and is > always false. It must not be used, and will be removed in API v1.48.

§exposed_ports: Option<HashMap<String, HashMap<(), ()>>>

An object mapping ports to an empty object in the form: {\"<port>/<tcp|udp|sctp>\": {}}

§tty: Option<bool>

Attach standard streams to a TTY, including stdin if it is not closed.


> Deprecated: this field is not part of the image specification and is > always false. It must not be used, and will be removed in API v1.48.

§open_stdin: Option<bool>

Open stdin


> Deprecated: this field is not part of the image specification and is > always false. It must not be used, and will be removed in API v1.48.

§stdin_once: Option<bool>

Close stdin after one attached client disconnects.


> Deprecated: this field is not part of the image specification and is > always false. It must not be used, and will be removed in API v1.48.

§env: Option<Vec<String>>

A list of environment variables to set inside the container in the form [\"VAR=value\", ...]. A variable without = is removed from the environment, rather than to have an empty value.

§cmd: Option<Vec<String>>

Command to run specified as a string or an array of strings.

§healthcheck: Option<HealthConfig>§args_escaped: Option<bool>

Command is already escaped (Windows only)

§image: Option<String>

The name (or reference) of the image to use when creating the container, or which was used when the container was created.


> Deprecated: this field is not part of the image specification and is > always empty. It must not be used, and will be removed in API v1.48.

§volumes: Option<HashMap<String, HashMap<(), ()>>>

An object mapping mount point paths inside the container to empty objects.

§working_dir: Option<String>

The working directory for commands to run in.

§entrypoint: Option<Vec<String>>

The entry point for the container as a string or an array of strings. If the array consists of exactly one empty string ([\"\"]) then the entry point is reset to system default (i.e., the entry point used by docker when there is no ENTRYPOINT instruction in the Dockerfile).

§network_disabled: Option<bool>

Disable networking for the container.


> Deprecated: this field is not part of the image specification and is > always omitted. It must not be used, and will be removed in API v1.48.

§mac_address: Option<String>

MAC address of the container.


> Deprecated: this field is not part of the image specification and is > always omitted. It must not be used, and will be removed in API v1.48.

§on_build: Option<Vec<String>>

ONBUILD metadata that were defined in the image’s Dockerfile.

§labels: Option<HashMap<String, String>>

User-defined key/value metadata.

§stop_signal: Option<String>

Signal to stop a container as a string or unsigned integer.

§stop_timeout: Option<i64>

Timeout to stop a container in seconds.


> Deprecated: this field is not part of the image specification and is > always omitted. It must not be used, and will be removed in API v1.48.

§shell: Option<Vec<String>>

Shell for when RUN, CMD, and ENTRYPOINT uses a shell.

Trait Implementations§

Source§

impl Clone for ImageConfig

Source§

fn clone(&self) -> ImageConfig

Returns a copy of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ImageConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ImageConfig

Source§

fn default() -> ImageConfig

Returns the “default value” for a type. Read more
Source§

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

Source§

fn deserialize<__D>( __deserializer: __D, ) -> Result<ImageConfig, <__D as Deserializer<'de>>::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for ImageConfig

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for ImageConfig

Source§

fn serialize<__S>( &self, __serializer: __S, ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ImageConfig

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> ErasedDestructor for T
where T: 'static,