Struct docker_api::api::container::Container

pub struct Container<'docker> { /* fields omitted */ }

Interface for accessing and manipulating Docker Container.

Api Reference

Implementations

impl<'docker> Container<'docker>

pub fn new<I>(docker: &'docker Docker, id: I) -> Self where
    I: Into<String>, 

Exports an interface exposing operations against a Container instance.

pub fn id(&self) -> &str

A getter for Container id

impl<'docker> Container<'docker>

pub async fn inspect(&self) -> Result<ContainerDetails>

Api Reference

Inspect this Container.

pub fn logs(
    &self,
    opts: &LogsOpts
) -> impl Stream<Item = Result<TtyChunk>> + Unpin + 'docker

Api Reference

Returns a stream of logs from a Container.

pub async fn remove(&self, opts: &RmContainerOpts) -> Result<String>

Api Reference

Delete this Container. Use delete to delete without options.

pub async fn delete(&self) -> Result<String>

Api Reference

Delete this Container. Use remove to customize options.

pub async fn top(&self, psargs: Option<&str>) -> Result<Top>

Api Reference

Returns a top view of information about the container process. On Unix systems, this is done by running the ps command. This endpoint is not supported on Windows.

pub async fn attach(&self) -> Result<TtyMultiplexer<'docker>>

Api Reference

Attaches a TtyMultiplexer to the container.

The TtyMultiplexer implements Stream for returning Stdout and Stderr chunks. It also implements AsyncWrite for writing to Stdin.

The multiplexer can be split into its read and write halves with the split method

pub async fn changes(&self) -> Result<Vec<Change>>

Api Reference

Returns a set of changes made to the container instance.

pub fn export(&self) -> impl Stream<Item = Result<Vec<u8>>> + 'docker

Api Reference

Exports the current docker container into a tarball.

pub fn stats(&self) -> impl Stream<Item = Result<Stats>> + Unpin + 'docker

Api Reference

Returns a stream of stats specific to this container instance.

pub async fn start(&self) -> Result<()>

Api Reference

Start the container instance.

pub async fn stop(&self, wait: Option<Duration>) -> Result<()>

Api Reference

Stop the container instance.

pub async fn restart(&self, wait: Option<Duration>) -> Result<()>

Api Reference

Restart the container instance.

pub async fn kill(&self, signal: Option<&str>) -> Result<()>

Api Reference

Kill the container instance.

pub async fn rename(&self, name: &str) -> Result<()>

Api Reference

Rename the container instance.

pub async fn pause(&self) -> Result<()>

Api Reference

Pause the container instance.

pub async fn unpause(&self) -> Result<()>

Api Reference

Unpause the container instance.

pub async fn wait(&self) -> Result<Exit>

Api Reference

Wait until the container stops.

pub fn exec(
    &'docker self,
    opts: &ExecContainerOpts
) -> impl Stream<Item = Result<TtyChunk>> + Unpin + 'docker

Api Reference

Execute a command in this container.

pub fn copy_from(
    &self,
    path: &Path
) -> impl Stream<Item = Result<Vec<u8>>> + 'docker

Api Reference

Copy a file/folder from the container. The resulting stream is a tarball of the extracted files.

If path is not an absolute path, it is relative to the container’s root directory. The resource specified by path must exist. To assert that the resource is expected to be a directory, path should end in / or /. (assuming a path separator of /). If path ends in /. then this indicates that only the contents of the path directory should be copied. A symlink is always resolved to its target.

pub async fn copy_file_into<P: AsRef<Path>>(
    &self,
    path: P,
    bytes: &[u8]
) -> Result<()>

Api Reference

Copy a byte slice as file into (see bytes) the container.

The file will be copied at the given location (see path) and will be owned by root with access mask 644.

pub async fn copy_to(&self, path: &Path, body: Body) -> Result<()>

Api Reference

Copy a tarball (see body) to the container.

The tarball will be copied to the container and extracted at the given location (see path).

pub async fn stat_file<P>(&self, path: P) -> Result<String> where
    P: AsRef<Path>, 

Api Reference

Get information about files in a container.

Trait Implementations

impl<'docker> Debug for Container<'docker>

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

Formats the value using the given formatter.