Skip to main content

ContainerSpec

Struct ContainerSpec 

Source
#[non_exhaustive]
pub struct ContainerSpec { pub name: String, pub image: String, pub env: HashMap<String, String>, pub cmd: Option<Vec<String>>, pub labels: HashMap<String, String>, pub restart_policy: RestartPolicy, pub ports: Vec<PortMapping>, pub volumes: Vec<VolumeMount>, pub network: Option<String>, }
Expand description

What to run.

#[non_exhaustive]: build with ContainerSpec::new and the with_* builders so fields can keep being added without breaking callers. Debug is hand-written and prints env keys only (see the module doc on credentials).

Fields (Non-exhaustive)§

This struct is marked as non-exhaustive
Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.
§name: String

Docker container name — must be unique per host.

§image: String§env: HashMap<String, String>

Environment variables. Not a credential channel: values are visible to docker inspect. See the module doc.

§cmd: Option<Vec<String>>

Override the image’s own ENTRYPOINT/CMD. None leaves the image’s own default command untouched.

§labels: HashMap<String, String>§restart_policy: RestartPolicy§ports: Vec<PortMapping>

Ports to publish to the host. Empty publishes nothing.

§volumes: Vec<VolumeMount>

Named volumes to attach. Empty attaches nothing.

§network: Option<String>

A user-defined Docker network to attach to instead of the default bridge (HostConfig.NetworkMode); containers on the same user-defined network resolve each other by container name. None keeps dockerd’s default. Create it with Lifecycle::ensure_network.

Implementations§

Source§

impl ContainerSpec

Source

pub fn new(name: impl Into<String>, image: impl Into<String>) -> Self

Source

pub fn with_env(self, env: HashMap<String, String>) -> Self

Source

pub fn with_cmd(self, cmd: Vec<String>) -> Self

Source

pub fn with_labels(self, labels: HashMap<String, String>) -> Self

Source

pub fn with_restart_policy(self, policy: RestartPolicy) -> Self

Source

pub fn with_port(self, port: PortMapping) -> Self

Publish one more port.

Source

pub fn with_ports(self, ports: Vec<PortMapping>) -> Self

Replace the published ports.

Source

pub fn with_volume(self, volume: VolumeMount) -> Self

Attach one more named volume.

Source

pub fn with_volumes(self, volumes: Vec<VolumeMount>) -> Self

Replace the attached volumes.

Source

pub fn with_network(self, name: impl Into<String>) -> Self

Attach to the user-defined network name.

Source

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

Reject specs dockerd would refuse or that would silently mean something else, before any Docker call. Called by Lifecycle::run; public so a caller can fail fast earlier.

Trait Implementations§

Source§

impl Clone for ContainerSpec

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ContainerSpec

Source§

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

Formats the value using the given formatter. Read more

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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 = !

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

fn try_from(value: U) -> Result<T, !>

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<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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