pub struct AttachCommand {
pub executor: CommandExecutor,
/* private fields */
}
Expand description
Docker attach command builder
Attach local standard input, output, and error streams to a running container.
§Example
use docker_wrapper::AttachCommand;
// Attach to a running container
AttachCommand::new("my-container")
.run()
.await?;
// Attach without stdin
AttachCommand::new("my-container")
.no_stdin()
.run()
.await?;
Fields§
§executor: CommandExecutor
Command executor
Implementations§
Source§impl AttachCommand
impl AttachCommand
Sourcepub fn new(container: impl Into<String>) -> Self
pub fn new(container: impl Into<String>) -> Self
Create a new attach command
§Example
use docker_wrapper::AttachCommand;
let cmd = AttachCommand::new("my-container");
Sourcepub fn detach_keys(self, keys: impl Into<String>) -> Self
pub fn detach_keys(self, keys: impl Into<String>) -> Self
Override the key sequence for detaching a container
§Example
use docker_wrapper::AttachCommand;
let cmd = AttachCommand::new("my-container")
.detach_keys("ctrl-a,ctrl-d");
Sourcepub fn no_stdin(self) -> Self
pub fn no_stdin(self) -> Self
Do not attach STDIN
§Example
use docker_wrapper::AttachCommand;
let cmd = AttachCommand::new("my-container")
.no_stdin();
Sourcepub fn no_sig_proxy(self) -> Self
pub fn no_sig_proxy(self) -> Self
Do not proxy signals
§Example
use docker_wrapper::AttachCommand;
let cmd = AttachCommand::new("my-container")
.no_sig_proxy();
Sourcepub async fn run(&self) -> Result<AttachResult>
pub async fn run(&self) -> Result<AttachResult>
Execute the attach command
§Errors
Returns an error if:
- The Docker daemon is not running
- The container doesn’t exist
- The container is not running
§Example
use docker_wrapper::AttachCommand;
let result = AttachCommand::new("my-container")
.run()
.await?;
if result.success() {
println!("Successfully attached to container");
}
Trait Implementations§
Source§impl Clone for AttachCommand
impl Clone for AttachCommand
Source§fn clone(&self) -> AttachCommand
fn clone(&self) -> AttachCommand
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source
. Read moreSource§impl Debug for AttachCommand
impl Debug for AttachCommand
Source§impl DockerCommand for AttachCommand
impl DockerCommand for AttachCommand
Source§type Output = CommandOutput
type Output = CommandOutput
The output type this command produces
Source§fn get_executor(&self) -> &CommandExecutor
fn get_executor(&self) -> &CommandExecutor
Get the command executor for extensibility
Source§fn get_executor_mut(&mut self) -> &mut CommandExecutor
fn get_executor_mut(&mut self) -> &mut CommandExecutor
Get mutable command executor for extensibility
Source§fn build_command_args(&self) -> Vec<String>
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,
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,
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
fn arg<S: AsRef<OsStr>>(&mut self, arg: S) -> &mut Self
Add a raw argument to the command (escape hatch)
Auto Trait Implementations§
impl Freeze for AttachCommand
impl RefUnwindSafe for AttachCommand
impl Send for AttachCommand
impl Sync for AttachCommand
impl Unpin for AttachCommand
impl UnwindSafe for AttachCommand
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more