Struct fizyr_rpc::PeerReadHandle[−][src]

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

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

[src]

impl<Body> PeerReadHandle<Body>

[src]

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.

[src]

pub fn close(&self)

Close the connection with the remote peer.

[src]

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

[src]

impl<Body> Debug for PeerReadHandle<Body>

[src]

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

Formats the value using the given formatter. Read more

[src]

impl<Body> Drop for PeerReadHandle<Body>

[src]

fn drop(&mut self)

Executes the destructor for this type. Read more

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

[src]

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

[src]

pub fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

[src]

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

[src]

pub fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

[src]

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

[src]

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

Mutably borrows from an owned value. Read more

[src]

impl<T> From<T> for T

[src]

pub fn from(t: T) -> T

Performs the conversion.

[src]

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

[src]

pub fn into(self) -> U

Performs the conversion.

[src]

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

type Error = Infallible

The type returned in the event of a conversion error.

[src]

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

Performs the conversion.

[src]

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

type Error = >::Error

The type returned in the event of a conversion error.

[src]

pub fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct fizyr_rpc::PeerReadHandle[−][src]

Implementations

impl<Body> PeerReadHandle<Body>

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

pub fn close(&self)

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

Trait Implementations

impl<Body> Debug for PeerReadHandle<Body>

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

impl<Body> Drop for PeerReadHandle<Body>

fn drop(&mut self)

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

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

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

type Error = Infallible

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

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

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

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

Struct fizyr_rpc::PeerReadHandle[−][src]

Implementations

impl<Body> PeerReadHandle<Body>

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

pub fn close(&self)

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

Trait Implementations

impl<Body> Debug for PeerReadHandle<Body>

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

impl<Body> Drop for PeerReadHandle<Body>

fn drop(&mut self)

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

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

pub fn type_id(&self) -> TypeId

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

pub fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

pub fn from(t: T) -> T

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

pub fn into(self) -> U

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

type Error = Infallible

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

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

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

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

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

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

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

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

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

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

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

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