[−][src]Struct fizyr_rpc::PeerHandle

pub struct PeerHandle<Body> { /* fields omitted */ }

Handle to a peer.

The handle can be used to receive incoming requests and stream messages, and to send requests and stream messages.

When the handle is dropped, the peer loop is stopped. Any open requests will also be terminated.

Implementations

impl<Body> PeerHandle<Body>[src]

pub fn split(self) -> (PeerReadHandle<Body>, PeerWriteHandle<Body>)[src]

Split the peer in a read handle and a write handle.

Splitting the peer allows you to move both handles into different tasks.

The original handle is consumed, but the peer loop will keep going until all read and write handles are dropped.

pub async fn next_message<'_>(
    &'_ mut self
) -> Result<Incoming<Body>, NextMessageError>[src]

Get the next request or stream message from the remote peer.

Errors for invalid incoming messages are also reported by this function. For example: incoming update messages that are not associated with a received request will be reported as an error here.

pub async fn send_request<'_>(
    &'_ mut self,
    service_id: i32,
    body: impl Into<Body>
) -> Result<SentRequest<Body>, SendRequestError>[src]

Send a new request to the remote peer.

pub async fn send_stream<'_>(
    &'_ mut self,
    service_id: i32,
    body: impl Into<Body>
) -> Result<(), WriteMessageError>[src]

Send a stream message to the remote peer.

pub fn close(self)[src]

Close the connection with the remote peer.

pub fn close_handle(&self) -> PeerCloseHandle<Body>[src]

Make a close handle for the peer.

The close handle can be used to close the connection with the remote peer. It can be cloned and moved around independently.

Auto Trait Implementations

impl<Body> !RefUnwindSafe for PeerHandle<Body>

impl<Body> Send for PeerHandle<Body> where
    Body: Send, 

impl<Body> Sync for PeerHandle<Body> where
    Body: Send, 

impl<Body> Unpin for PeerHandle<Body>

impl<Body> !UnwindSafe for PeerHandle<Body>

Blanket Implementations

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

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

impl<T> From<T> for T[src]

impl<T, U> Into<U> for T where
    U: From<T>, [src]

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.