ExecCommand

Struct ExecCommand 

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

Docker exec command builder with fluent API

Fields§

§executor: CommandExecutor

Command executor for extensibility

Implementations§

Source§

impl ExecCommand

Source

pub fn new(container: impl Into<String>, command: Vec<String>) -> Self

Create a new exec command for the specified container and command

§Examples
use docker_wrapper::ExecCommand;

let exec_cmd = ExecCommand::new("my-container", vec!["ls".to_string(), "-la".to_string()]);
Source

pub fn detach(self) -> Self

Run in detached mode (background)

§Examples
use docker_wrapper::ExecCommand;

let exec_cmd = ExecCommand::new("my-container", vec!["sleep".to_string(), "10".to_string()])
    .detach();
Source

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

Override the key sequence for detaching a container

§Examples
use docker_wrapper::ExecCommand;

let exec_cmd = ExecCommand::new("my-container", vec!["bash".to_string()])
    .detach_keys("ctrl-p,ctrl-q");
Source

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

Add an environment variable

§Examples
use docker_wrapper::ExecCommand;

let exec_cmd = ExecCommand::new("my-container", vec!["env".to_string()])
    .env("DEBUG", "1")
    .env("LOG_LEVEL", "info");
Source

pub fn envs(self, vars: HashMap<String, String>) -> Self

Add multiple environment variables

§Examples
use docker_wrapper::ExecCommand;
use std::collections::HashMap;

let mut env_vars = HashMap::new();
env_vars.insert("DEBUG".to_string(), "1".to_string());
env_vars.insert("LOG_LEVEL".to_string(), "info".to_string());

let exec_cmd = ExecCommand::new("my-container", vec!["env".to_string()])
    .envs(env_vars);
Source

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

Add an environment file

§Examples
use docker_wrapper::ExecCommand;

let exec_cmd = ExecCommand::new("my-container", vec!["env".to_string()])
    .env_file("/path/to/env.file");
Source

pub fn interactive(self) -> Self

Keep STDIN open even if not attached

§Examples
use docker_wrapper::ExecCommand;

let exec_cmd = ExecCommand::new("my-container", vec!["bash".to_string()])
    .interactive();
Source

pub fn privileged(self) -> Self

Give extended privileges to the command

§Examples
use docker_wrapper::ExecCommand;

let exec_cmd = ExecCommand::new("my-container", vec!["mount".to_string()])
    .privileged();
Source

pub fn tty(self) -> Self

Allocate a pseudo-TTY

§Examples
use docker_wrapper::ExecCommand;

let exec_cmd = ExecCommand::new("my-container", vec!["bash".to_string()])
    .tty();
Source

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

Set username or UID (format: “<name|uid>[:<group|gid>]”)

§Examples
use docker_wrapper::ExecCommand;

let exec_cmd = ExecCommand::new("my-container", vec!["whoami".to_string()])
    .user("root");

let exec_cmd2 = ExecCommand::new("my-container", vec!["id".to_string()])
    .user("1000:1000");
Source

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

Set working directory inside the container

§Examples
use docker_wrapper::ExecCommand;

let exec_cmd = ExecCommand::new("my-container", vec!["pwd".to_string()])
    .workdir("/app");
Source

pub fn it(self) -> Self

Convenience method for interactive TTY mode

§Examples
use docker_wrapper::ExecCommand;

let exec_cmd = ExecCommand::new("my-container", vec!["bash".to_string()])
    .it();

Trait Implementations§

Source§

impl Clone for ExecCommand

Source§

fn clone(&self) -> ExecCommand

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 ExecCommand

Source§

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

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

impl DockerCommand for ExecCommand

Source§

type Output = ExecOutput

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,