Skip to main content

TunnelClient

Struct TunnelClient 

Source
pub struct TunnelClient<S> { /* private fields */ }
Expand description

A typed client for the tunnel registration interface.

Wraps an RpcClient and exposes only plain Rust types so the caller never touches Cap’n Proto directly.

Implementations§

Source§

impl<S: AsyncStream + Unpin> TunnelClient<S>

Source

pub fn new(rpc: RpcClient<S>) -> Self

Wraps an RpcClient as a typed registration client.

Source

pub async fn bootstrap(&mut self) -> Result<(), RpcError>

Bootstraps the edge’s registration interface.

Source

pub async fn register_connection( &mut self, auth: TunnelAuth, tunnel_identifier: &[u8], connection_index: u8, options: &ConnectionOptions, ) -> Result<ConnectionResponse, RpcError>

Calls registerConnection with the tunnel credentials and options.

Source

pub async fn unregister_connection(&mut self) -> Result<(), RpcError>

Calls unregisterConnection for the current connection.

Source

pub async fn update_local_configuration( &mut self, configuration: &[u8], ) -> Result<(), RpcError>

Pushes the local configuration to the edge via updateLocalConfiguration (for locally-managed tunnels).

Source

pub fn into_inner(self) -> RpcClient<S>

Returns the underlying RpcClient without releasing the registration capability.

Source

pub async fn close(self) -> Result<S, RpcError>

Releases the registration capability and returns the underlying stream, mirroring capnp-go’s client Close().

Auto Trait Implementations§

§

impl<S> Freeze for TunnelClient<S>
where RpcClient<S>: Freeze,

§

impl<S> RefUnwindSafe for TunnelClient<S>

§

impl<S> Send for TunnelClient<S>
where RpcClient<S>: Send,

§

impl<S> Sync for TunnelClient<S>
where RpcClient<S>: Sync,

§

impl<S> Unpin for TunnelClient<S>
where RpcClient<S>: Unpin,

§

impl<S> UnsafeUnpin for TunnelClient<S>

§

impl<S> UnwindSafe for TunnelClient<S>

Blanket Implementations§

Source§

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

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

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

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

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

Source§

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

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

fn in_current_span(self) -> Instrumented<Self>

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

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

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.

Source§

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

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

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
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

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