Struct bollard::container::AttachContainerOptions

pub struct AttachContainerOptions<T>
where
    T: Into<String> + Serialize + Default,
{
    pub stdin: Option<bool>,
    pub stdout: Option<bool>,
    pub stderr: Option<bool>,
    pub stream: Option<bool>,
    pub logs: Option<bool>,
    pub detach_keys: Option<T>,
}

Parameters used in the Attach Container API

Examples

use bollard::container::AttachContainerOptions;

AttachContainerOptions::<String>{
    stdin: Some(true),
    stdout: Some(true),
    stderr: Some(true),
    stream: Some(true),
    logs: Some(true),
    detach_keys: Some("ctrl-c".to_string()),
};

Fields

stdin: Option<bool>

Attach to stdin

stdout: Option<bool>

Attach to stdout

stderr: Option<bool>

Attach to stderr

stream: Option<bool>

Stream attached streams from the time the request was made onwards.

logs: Option<bool>

Replay previous logs from the container. This is useful for attaching to a container that has started and you want to output everything since the container started. If stream is also enabled, once all the previous output has been returned, it will seamlessly transition into streaming current output.

detach_keys: Option<T>

Override the key sequence for detaching a container. Format is a single character [a-Z] or ctrl- where is one of: a-z, @, ^, [, , or _.

Trait Implementations

impl<T> Clone for AttachContainerOptions<T>

where T: Into<String> + Serialize + Default + Clone,

fn clone(&self) -> AttachContainerOptions<T>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for AttachContainerOptions<T>

where T: Into<String> + Serialize + Default + Debug,

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

Formats the value using the given formatter.

impl<T> Default for AttachContainerOptions<T>

where T: Into<String> + Serialize + Default + Default,

fn default() -> AttachContainerOptions<T>

Returns the “default value” for a type.

impl<T> PartialEq for AttachContainerOptions<T>

where T: Into<String> + Serialize + Default + PartialEq,

fn eq(&self, other: &AttachContainerOptions<T>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Serialize for AttachContainerOptions<T>

where T: Into<String> + Serialize + Default + Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<T> Copy for AttachContainerOptions<T>

where T: Into<String> + Serialize + Default + Copy,

impl<T> StructuralPartialEq for AttachContainerOptions<T>

where T: Into<String> + Serialize + Default,