Skip to main content

RpcClient

Struct RpcClient 

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

A minimal Cap’n Proto RPC client for tunnel registration.

Implements the exact wire sequence cloudflared uses on its control stream: bootstrap to obtain the peer’s main interface, then call/return/finish for each registration method. Question ids are allocated monotonically from 0 and the bootstrapped capability is tracked as import id 0.

All capnp message construction and decoding happens in synchronous helpers so no non-Send capnp state is held across an await, keeping every future Send.

Implementations§

Source§

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

Source

pub fn new(stream: S) -> Self

Wraps a bidirectional stream as an RPC client.

Source

pub fn into_inner(self) -> S

Returns the underlying stream (the connection stays open).

Source

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

Sends Message::bootstrap and waits for the return carrying the peer’s main interface. Returns the import id to use for calls.

Source

pub async fn call<T>( &mut self, import_identifier: u32, interface_identifier: u64, method_identifier: u16, fill_parameters: impl FnOnce(&mut Builder<'_>) -> Result<(), RpcError>, decode: impl FnOnce(Reader<'_>) -> Result<T, RpcError>, ) -> Result<T, RpcError>

Performs a method call on an imported capability, decodes the results payload with decode, then sends finish for the question.

Source

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

Releases the bootstrapped capability and returns the underlying stream. Sends Message::release for import id 0, mirroring what capnp-go sends when a registration client is closed.

Auto Trait Implementations§

§

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

§

impl<S> RefUnwindSafe for RpcClient<S>
where S: RefUnwindSafe,

§

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

§

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

§

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

§

impl<S> UnsafeUnpin for RpcClient<S>
where S: UnsafeUnpin,

§

impl<S> UnwindSafe for RpcClient<S>
where S: UnwindSafe,

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