Struct kube_client::api::Portforwarder

source · [−]

pub struct Portforwarder { /* private fields */ }

Available on crate feature client only.

Expand description

Manages port-forwarded streams.

Provides AsyncRead + AsyncWrite for each port and does not bind to local ports. Error channel for each port is only written by the server when there’s an exception and the port cannot be used (didn’t initialize or can’t be used anymore).

Implementations

impl Portforwarder

pub fn take_stream(
&mut self,
port: u16
) -> Option<impl AsyncRead + AsyncWrite + Unpin>

Take a port stream by the port on the target resource.

A value is returned at most once per port.

pub fn take_error(
&mut self,
port: u16
) -> Option<impl Future<Output = Option<String>>>

Take a future that resolves with any error message or when the error sender is dropped. When the future resolves, the port should be considered no longer usable.

A value is returned at most once per port.

pub fn abort(&self)

Abort the background task, causing port forwards to fail.

pub async fn join(self) -> Result<(), Error>

Waits for port forwarding task to complete.

Auto Trait Implementations

impl !RefUnwindSafe for Portforwarder

impl Send for Portforwarder

impl Sync for Portforwarder

impl Unpin for Portforwarder

impl !UnwindSafe for Portforwarder

Blanket Implementations

impl<T> Any for T where
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more

impl<T, U> Into<U> for T where
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

impl<T> Same<T> for T

type Output = T

Should always be Self

impl<T, U> TryFrom<U> for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.

impl<V, T> VZip<V> for T where
V: MultiLane<T>,

fn vzip(self) -> V

impl<T> WithSubscriber for T

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more