Struct kube_client::api::AttachParams

pub struct AttachParams {
    pub container: Option<String>,
    pub stdin: bool,
    pub stdout: bool,
    pub stderr: bool,
    pub tty: bool,
    pub max_stdin_buf_size: Option<usize>,
    pub max_stdout_buf_size: Option<usize>,
    pub max_stderr_buf_size: Option<usize>,
}

Available on crate features client and ws only.

Parameters for attaching to a container in a Pod.

• One of stdin, stdout, or stderr must be true.
• stderr and tty cannot both be true because multiplexing is not supported with TTY.

Fields

container: Option<String>

The name of the container to attach. Defaults to the only container if there is only one container in the pod.

stdin: bool

Attach to the container’s standard input. Defaults to false.

Call AttachedProcess::stdin to obtain a writer.

stdout: bool

Attach to the container’s standard output. Defaults to true.

Call AttachedProcess::stdout to obtain a reader.

stderr: bool

Attach to the container’s standard error. Defaults to true.

Call AttachedProcess::stderr to obtain a reader.

tty: bool

Allocate TTY. Defaults to false.

NOTE: Terminal resizing is not implemented yet.

max_stdin_buf_size: Option<usize>

The maximum amount of bytes that can be written to the internal stdin pipe before the write returns Poll::Pending. Defaults to 1024.

This is not sent to the server.

max_stdout_buf_size: Option<usize>

The maximum amount of bytes that can be written to the internal stdout pipe before the write returns Poll::Pending. Defaults to 1024.

This is not sent to the server.

max_stderr_buf_size: Option<usize>

The maximum amount of bytes that can be written to the internal stderr pipe before the write returns Poll::Pending. Defaults to 1024.

This is not sent to the server.

Implementations

impl AttachParams

pub fn interactive_tty() -> AttachParams

Default parameters for an tty exec with stdin and stdout

pub fn container<T>(self, container: T) -> AttachParams

where T: Into<String>,

Specify the container to execute in.

pub fn stdin(self, enable: bool) -> AttachParams

Set stdin field.

pub fn stdout(self, enable: bool) -> AttachParams

Set stdout field.

pub fn stderr(self, enable: bool) -> AttachParams

Set stderr field.

pub fn tty(self, enable: bool) -> AttachParams

Set tty field.

pub fn max_stdin_buf_size(self, size: usize) -> AttachParams

Set max_stdin_buf_size field.

pub fn max_stdout_buf_size(self, size: usize) -> AttachParams

Set max_stdout_buf_size field.

pub fn max_stderr_buf_size(self, size: usize) -> AttachParams

Set max_stderr_buf_size field.

Trait Implementations

impl Debug for AttachParams

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

Formats the value using the given formatter.

impl Default for AttachParams

fn default() -> AttachParams

Returns the “default value” for a type.