Struct fizyr_rpc::PeerReadHandle

source · 
pub struct PeerReadHandle<Body> { /* private fields */ }
Expand description

Handle to receive messages from a peer.

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

When all read and write handles are dropped, the peer loop is stopped. Any open requests will also be terminated.

Implementations§

source§

impl<Body> PeerReadHandle<Body>

source

pub async fn recv_message(&mut self) -> Result<ReceivedMessage<Body>, Error>

Receive 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.

source

pub fn close(&self)

Close the connection with the remote peer.

source

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

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.

Trait Implementations§

source§

impl<Body> Debug for PeerReadHandle<Body>

source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
source§

impl<Body> Drop for PeerReadHandle<Body>

source§

fn drop(&mut self)

Executes the destructor for this type. Read more
source§

impl<F: Format> From<PeerReadHandle<<F as Format>::Body>> for Server<F>

source§

fn from(other: PeerReadHandle<F::Body>) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl<Body> !RefUnwindSafe for PeerReadHandle<Body>

§

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

§

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

§

impl<Body> Unpin for PeerReadHandle<Body>

§

impl<Body> !UnwindSafe for PeerReadHandle<Body>

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, 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>,

§

type Error = Infallible

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

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

Performs the conversion.
source§

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.
source§

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

Performs the conversion.