Struct kube::api::AttachParams [−][src]
ws
only.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
impl AttachParams
[src]
pub fn interactive_tty() -> Self
[src]
Default parameters for an tty exec with stdin and stdout
pub fn container<T: Into<String>>(self, container: T) -> Self
[src]
Specify the container to execute in.
pub fn stdin(self, enable: bool) -> Self
[src]
Set stdin
field.
pub fn stdout(self, enable: bool) -> Self
[src]
Set stdout
field.
pub fn stderr(self, enable: bool) -> Self
[src]
Set stderr
field.
pub fn tty(self, enable: bool) -> Self
[src]
Set tty
field.
pub fn max_stdin_buf_size(self, size: usize) -> Self
[src]
Set max_stdin_buf_size
field.
pub fn max_stdout_buf_size(self, size: usize) -> Self
[src]
Set max_stdout_buf_size
field.
pub fn max_stderr_buf_size(self, size: usize) -> Self
[src]
Set max_stderr_buf_size
field.
Trait Implementations
impl Default for AttachParams
[src]
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
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T> Instrument for T
[src]
pub fn instrument(self, span: Span) -> Instrumented<Self>
[src]
pub fn in_current_span(self) -> Instrumented<Self>
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Same<T> for T
type Output = T
Should always be Self
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,