Struct Definition 

pub struct Definition { /* private fields */ }

Implementations

impl Definition

pub fn new(backend: Backend, reference: Reference) -> Definition

pub fn with_container<F, R>(&self, f: F) -> R

where F: FnOnce(&mut Container) -> R,

Runs a detached container and passes it to the provided closure.

The container is automatically stopped when dropped (after the closure returns or on panic).

pub fn backend(self, backend: Backend) -> Self

pub fn entrypoint(self, command: impl Into<Entrypoint>) -> Self

pub fn workdir(self, path: impl Into<Workdir>) -> Self

pub fn arguments( self, arguments: impl IntoIterator<Item = impl Into<ContainerArgument>>, ) -> Self

pub fn argument(self, argument: impl Into<ContainerArgument>) -> Self

pub fn environment_variable(self, key: &str, value: &str) -> Self

pub fn environment_variables<K: ToString, V: ToString>( self, values: impl IntoIterator<Item = (K, V)>, ) -> Self

pub fn remove(self) -> Self

pub fn no_remove(self) -> Self

pub fn stop_on_drop(self) -> Self

Marks the container to be stopped when the Container handle is dropped.

By default containers are not stopped on drop. Use this when you want automatic cleanup of running containers when the handle goes out of scope.

pub fn remove_on_drop(self) -> Self

Marks the container for removal when the Container handle is dropped.

This is different from remove() which uses --rm flag:

• remove() → docker/podman removes container when it stops (can’t commit)
• remove_on_drop() → Rust removes container on Drop (can commit stopped container)

Use this when you need to stop a container, commit it, then clean up.

pub fn detach(self) -> Self

pub fn no_detach(self) -> Self

pub fn publish(self, value: impl Into<Publish>) -> Self

pub fn publishes( self, values: impl IntoIterator<Item = impl Into<Publish>>, ) -> Self

pub fn mount(self, value: impl Into<Mount>) -> Self

pub fn mounts(self, values: impl IntoIterator<Item = impl Into<Mount>>) -> Self

pub fn run_detached(&self) -> Container

pub fn run_capture_only_stdout(&self) -> Vec<u8>

pub fn run(&self) -> Result<(), CommandError>

Runs the container and returns success or an error.

Trait Implementations

impl Clone for Definition

fn clone(&self) -> Definition

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Definition

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

Formats the value using the given formatter.

impl PartialEq for Definition

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

impl StructuralPartialEq for Definition