Struct kube::core::subresource::AttachParams
source · 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>,
}
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§
source§impl AttachParams
impl AttachParams
sourcepub fn interactive_tty() -> AttachParams
Available on crate feature client
only.
pub fn interactive_tty() -> AttachParams
client
only.Default parameters for an tty exec with stdin and stdout
sourcepub fn container<T>(self, container: T) -> AttachParams
Available on crate feature client
only.
pub fn container<T>(self, container: T) -> AttachParams
client
only.Specify the container to execute in.
sourcepub fn stdin(self, enable: bool) -> AttachParams
Available on crate feature client
only.
pub fn stdin(self, enable: bool) -> AttachParams
client
only.Set stdin
field.
sourcepub fn stdout(self, enable: bool) -> AttachParams
Available on crate feature client
only.
pub fn stdout(self, enable: bool) -> AttachParams
client
only.Set stdout
field.
sourcepub fn stderr(self, enable: bool) -> AttachParams
Available on crate feature client
only.
pub fn stderr(self, enable: bool) -> AttachParams
client
only.Set stderr
field.
sourcepub fn tty(self, enable: bool) -> AttachParams
Available on crate feature client
only.
pub fn tty(self, enable: bool) -> AttachParams
client
only.Set tty
field.
sourcepub fn max_stdin_buf_size(self, size: usize) -> AttachParams
Available on crate feature client
only.
pub fn max_stdin_buf_size(self, size: usize) -> AttachParams
client
only.Set max_stdin_buf_size
field.
sourcepub fn max_stdout_buf_size(self, size: usize) -> AttachParams
Available on crate feature client
only.
pub fn max_stdout_buf_size(self, size: usize) -> AttachParams
client
only.Set max_stdout_buf_size
field.
sourcepub fn max_stderr_buf_size(self, size: usize) -> AttachParams
Available on crate feature client
only.
pub fn max_stderr_buf_size(self, size: usize) -> AttachParams
client
only.Set max_stderr_buf_size
field.
Trait Implementations§
source§impl Debug for AttachParams
impl Debug for AttachParams
source§impl Default for AttachParams
impl Default for AttachParams
source§fn default() -> AttachParams
fn default() -> AttachParams
Auto Trait Implementations§
impl Freeze for AttachParams
impl RefUnwindSafe for AttachParams
impl Send for AttachParams
impl Sync for AttachParams
impl Unpin for AttachParams
impl UnwindSafe for AttachParams
Blanket Implementations§
source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
source§impl<T> Instrument for T
impl<T> Instrument for T
source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
source§impl<T> IntoEither for T
impl<T> IntoEither for T
source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moresource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read more