RpcStream

Struct RpcStream 

Source
pub struct RpcStream<T> { /* private fields */ }
Expand description

A bidirectional RPC stream.

RpcStream allows sending and receiving multiple items over a single RPC call. It implements Stream for receiving items.

§Example

// Server streaming
async fn get_logs(&self, filter: Filter) -> RpcStream<LogEntry>;

// Client usage
let mut stream = client.get_logs(filter).await?;
while let Some(entry) = stream.next().await {
    println!("{:?}", entry?);
}

Implementations§

Source§

impl<T> RpcStream<T>

Source

pub fn new(rx: Receiver<Result<T, String>>) -> Self

Create a new stream with the given receiver.

Source

pub fn bidirectional(rx: Receiver<Result<T, String>>, tx: Sender<Bytes>) -> Self

Create a bidirectional stream with both send and receive capabilities.

Source

pub fn sender(&self) -> Option<&StreamSender<T>>

Get the sender half for bidirectional streams.

Source

pub async fn next(&mut self) -> Option<Result<T, String>>

Receive the next item from the stream.

Trait Implementations§

Source§

impl<T: Serialize + Unpin> ErasedStream for RpcStream<T>

Source§

fn poll_next_bytes( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Result<Vec<u8>, String>>>

Get the next item as serialized bytes.
Source§

impl<T: Unpin> Stream for RpcStream<T>

Source§

type Item = Result<T, String>

Values yielded by the stream.
Source§

fn poll_next( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Option<Self::Item>>

Attempt to pull out the next value of this stream, registering the current task for wakeup if the value is not yet available, and returning None if the stream is exhausted. Read more
Source§

fn size_hint(&self) -> (usize, Option<usize>)

Returns the bounds on the remaining length of the stream. Read more

Auto Trait Implementations§

§

impl<T> Freeze for RpcStream<T>

§

impl<T> RefUnwindSafe for RpcStream<T>
where T: RefUnwindSafe,

§

impl<T> Send for RpcStream<T>
where T: Send,

§

impl<T> Sync for RpcStream<T>
where T: Sync + Send,

§

impl<T> Unpin for RpcStream<T>
where T: Unpin,

§

impl<T> UnwindSafe for RpcStream<T>
where T: 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, 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 = 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>,

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<S, T, E> TryStream for S
where S: Stream<Item = Result<T, E>> + ?Sized,

Source§

type Ok = T

The type of successful values yielded by this future
Source§

type Error = E

The type of failures yielded by this future
Source§

fn try_poll_next( self: Pin<&mut S>, cx: &mut Context<'_>, ) -> Poll<Option<Result<<S as TryStream>::Ok, <S as TryStream>::Error>>>

Poll this TryStream as if it were a Stream. Read more