Struct kube::api::AttachParams [−][src]
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>,
}
client
and ws
only.Expand description
Parameters for attaching to a container in a Pod.
- One of
stdin
,stdout
, orstderr
must betrue
. stderr
andtty
cannot both betrue
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
Default parameters for an tty exec with stdin and stdout
Specify the container to execute in.
Set stdin
field.
Set stdout
field.
Set stderr
field.
Set tty
field.
Set max_stdin_buf_size
field.
Set max_stdout_buf_size
field.
Set max_stderr_buf_size
field.
Trait Implementations
Returns the “default value” for a type. Read more
Auto Trait Implementations
impl RefUnwindSafe for AttachParams
impl Send for AttachParams
impl Sync for AttachParams
impl Unpin for AttachParams
impl UnwindSafe for AttachParams
Blanket Implementations
Mutably borrows from an owned value. Read more
pub fn vzip(self) -> V
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more