Struct AsyncProstStream

Source
pub struct AsyncProstStream<S, R, W, D> { /* private fields */ }
Expand description

A wrapper around an async stream that receives and sends prost-encoded values

Implementations§

Source§

impl<S, R, W, D> AsyncProstStream<S, R, W, D>

Source

pub fn get_ref(&self) -> &S

Gets a reference to the underlying stream.

It is inadvisable to directly read from or write to the underlying stream.

Source

pub fn get_mut(&mut self) -> &mut S

Gets a mutable reference to the underlying stream.

It is inadvisable to directly read from or write to the underlying stream.

Source

pub fn into_inner(self) -> S

Unwraps this AsyncProstStream, returning the underlying stream.

Note that any leftover serialized data that has not yet been sent, or received data that has not yet been deserialized, is lost.

Source§

impl<S, R, W, D> AsyncProstStream<S, R, W, D>

Source

pub fn for_async(self) -> AsyncProstStream<S, R, W, AsyncDestination>

make this stream include the serialized data’s size before each serialized value

Source

pub fn for_async_framed( self, ) -> AsyncProstStream<S, R, W, AsyncFrameDestination>

make this stream include the serialized data’s size before each serialized value

Source

pub fn for_sync(self) -> AsyncProstStream<S, R, W, SyncDestination>

Make this stream only send prost-encoded values

Source§

impl<R, W, D> AsyncProstStream<TcpStream, R, W, D>

Source

pub fn tcp_split( &mut self, ) -> (AsyncProstReader<ReadHalf<'_>, R, D>, AsyncProstWriter<WriteHalf<'_>, W, D>)

split a TCP-based stream into a read half and a write half

Trait Implementations§

Source§

impl<S: Debug, R: Debug, W: Debug, D: Debug> Debug for AsyncProstStream<S, R, W, D>

Source§

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

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

impl<S, R, W> Default for AsyncProstStream<S, R, W, SyncDestination>
where S: Default,

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<S, R, W> From<S> for AsyncProstStream<S, R, W, SyncDestination>

Source§

fn from(stream: S) -> Self

Converts to this type from the input type.
Source§

impl<S, R, W, D> Sink<W> for AsyncProstStream<S, R, W, D>
where S: Unpin, AsyncProstWriter<S, W, D>: Sink<W, Error = Error>,

Source§

type Error = Error

The type of value produced by the sink when an error occurs.
Source§

fn poll_ready( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Attempts to prepare the Sink to receive a value. Read more
Source§

fn start_send(self: Pin<&mut Self>, item: W) -> Result<(), Self::Error>

Begin the process of sending a value to the sink. Each call to this function must be preceded by a successful call to poll_ready which returned Poll::Ready(Ok(())). Read more
Source§

fn poll_flush( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output from this sink. Read more
Source§

fn poll_close( self: Pin<&mut Self>, cx: &mut Context<'_>, ) -> Poll<Result<(), Self::Error>>

Flush any remaining output and close this sink, if necessary. Read more
Source§

impl<S, R, W, D> Stream for AsyncProstStream<S, R, W, D>
where S: Unpin, AsyncProstReader<InternalAsyncWriter<S, W, D>, R, D>: Stream<Item = Result<R, Error>>,

Source§

type Item = Result<R, Error>

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<S, R, W, D> Freeze for AsyncProstStream<S, R, W, D>
where S: Freeze,

§

impl<S, R, W, D> RefUnwindSafe for AsyncProstStream<S, R, W, D>

§

impl<S, R, W, D> Send for AsyncProstStream<S, R, W, D>
where R: Send, D: Send, S: Send, W: Send,

§

impl<S, R, W, D> Sync for AsyncProstStream<S, R, W, D>
where R: Sync, D: Sync, S: Sync, W: Sync,

§

impl<S, R, W, D> Unpin for AsyncProstStream<S, R, W, D>

§

impl<S, R, W, D> UnwindSafe for AsyncProstStream<S, R, W, D>

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<!> for T

Source§

fn from(t: !) -> T

Converts to this type from the input type.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
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