CreateCommand

Struct CreateCommand 

Source
pub struct CreateCommand {
    pub executor: CommandExecutor,
    /* private fields */
}
Expand description

Docker create command builder

Create a new container without starting it. This is useful for preparing containers that will be started later.

§Example

use docker_wrapper::CreateCommand;

// Create a simple container
let result = CreateCommand::new("alpine:latest")
    .name("my-container")
    .run()
    .await?;

println!("Created container: {}", result.container_id());

Fields§

§executor: CommandExecutor

Command executor

Implementations§

Source§

impl CreateCommand

Source

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

Create a new create command

§Example
use docker_wrapper::CreateCommand;

let cmd = CreateCommand::new("nginx:latest");
Source

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

Set the container name

§Example
use docker_wrapper::CreateCommand;

let cmd = CreateCommand::new("alpine:latest")
    .name("my-container");
Source

pub fn cmd(self, command: Vec<impl Into<String>>) -> Self

Set the command to run in the container

§Example
use docker_wrapper::CreateCommand;

let cmd = CreateCommand::new("alpine:latest")
    .cmd(vec!["echo", "hello world"]);
Source

pub fn env(self, key: impl Into<String>, value: impl Into<String>) -> Self

Add an environment variable

§Example
use docker_wrapper::CreateCommand;

let cmd = CreateCommand::new("alpine:latest")
    .env("KEY", "value")
    .env("DEBUG", "true");
Source

pub fn port(self, host_port: u16, container_port: u16) -> Self

Add a port mapping

§Example
use docker_wrapper::CreateCommand;

let cmd = CreateCommand::new("nginx:latest")
    .port(8080, 80);
Source

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

Set working directory

Source

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

Set user

Source

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

Set hostname

Source

pub fn attach_stdin(self) -> Self

Attach to STDIN

Source

pub fn attach_stdout(self) -> Self

Attach to STDOUT

Source

pub fn attach_stderr(self) -> Self

Attach to STDERR

Source

pub fn interactive(self) -> Self

Enable interactive mode

Source

pub fn tty(self) -> Self

Allocate a pseudo-TTY

Source

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

Add a volume mount

§Example
use docker_wrapper::CreateCommand;

let cmd = CreateCommand::new("alpine:latest")
    .volume("/host/path:/container/path")
    .volume("/host/data:/data:ro");
Source

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

Add a label

Source

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

Set memory limit

Source

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

Set CPU limit

Source

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

Set network mode

Source

pub async fn run(&self) -> Result<CreateResult>

Execute the create command

§Errors

Returns an error if:

  • The Docker daemon is not running
  • The specified image doesn’t exist
  • Invalid configuration options
§Example
use docker_wrapper::CreateCommand;

let result = CreateCommand::new("alpine:latest")
    .name("test-container")
    .cmd(vec!["echo", "hello"])
    .run()
    .await?;

if result.success() {
    println!("Created container: {}", result.container_id());
}

Trait Implementations§

Source§

impl Clone for CreateCommand

Source§

fn clone(&self) -> CreateCommand

Returns a duplicate 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 CreateCommand

Source§

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

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

impl DockerCommand for CreateCommand

Source§

type Output = CommandOutput

The output type this command produces
Source§

fn get_executor(&self) -> &CommandExecutor

Get the command executor for extensibility
Source§

fn get_executor_mut(&mut self) -> &mut CommandExecutor

Get mutable command executor for extensibility
Source§

fn build_command_args(&self) -> Vec<String>

Build the complete command arguments including subcommands
Source§

fn execute<'life0, 'async_trait>( &'life0 self, ) -> Pin<Box<dyn Future<Output = Result<Self::Output>> + Send + 'async_trait>>
where Self: 'async_trait, 'life0: 'async_trait,

Execute the command and return the typed output
Source§

fn execute_command<'life0, 'async_trait>( &'life0 self, command_args: Vec<String>, ) -> Pin<Box<dyn Future<Output = Result<CommandOutput>> + Send + 'async_trait>>
where Self: Sync + 'async_trait, 'life0: 'async_trait,

Helper method to execute the command with proper error handling
Source§

fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Self

Add a raw argument to the command (escape hatch)
Source§

fn args<I, S>(&mut self, args: I) -> &mut Self
where I: IntoIterator<Item = S>, S: AsRef<OsStr>,

Add multiple raw arguments to the command (escape hatch)
Source§

fn flag(&mut self, flag: &str) -> &mut Self

Add a flag option (e.g., –detach, –rm)
Source§

fn option(&mut self, key: &str, value: &str) -> &mut Self

Add a key-value option (e.g., –name value, –env key=value)

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: 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: 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> 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> ErasedDestructor for T
where T: 'static,