Struct bandsocks::Container

pub struct Container {
    pub stdin: Option<UnixStream>,
    pub stdout: Option<UnixStream>,
    pub stderr: Option<UnixStream>,
    // some fields omitted
}

A running container

Roughly analogous to std::process::Child, but for a sandbox container.

Fields

stdin: Option<UnixStream>

stdout: Option<UnixStream>

stderr: Option<UnixStream>

Implementations

impl Container

pub fn new(image: Arc<Image>) -> Result<ContainerBuilder, ImageError>

Prepare to run a new container, starting with an Image loaded

pub async fn pull<'_>(
    name: &'_ ImageName
) -> Result<ContainerBuilder, ImageError>

Prepare to run a new container, starting with an ImageName referencing a repository server.

This is equivalent to using RegistryClient::pull() followed by Container::new(), which as an alternative allows using custom settings for RegistryClient.

pub async fn wait(self) -> Result<ExitStatus, RuntimeError>

Wait for the container to finish running, if necessary, and return its exit status.

pub async fn interact(self) -> Result<ExitStatus, RuntimeError>

Wait for the container to finish running, while connecting it to stdio

Any stdio streams which haven't been taken from the Container or overridden with ContainerBuilder will be forwarded to/from their real equivalents until the container exits.

If stdin is available to forward, we will use a separate thread for the blocking stdin reads. This thread may continue running after the container itself exits, since std's stdin reads cannot be cancelled.

pub async fn output(self) -> Result<Output, RuntimeError>

Capture the container's output and wait for it to finish

This will capture stderr and stdout if they have not been taken from the Container or overridden with ContainerBuilder.

If stdin has not been taken or overridden, it will be dropped.

Trait Implementations

impl Debug for Container

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

Formats the value using the given formatter.