[−][src]Struct async_bincode::AsyncBincodeWriter
A wrapper around an asynchronous sink that accepts, serializes, and sends bincode-encoded values.
To use, provide a writer that implements futures::AsyncWrite, and then use futures::Sink
to send values.
Note that an AsyncBincodeWriter must be of the type AsyncDestination in order to be
compatible with an [AsyncBincodeReader] on the remote end (recall that it requires the
serialized size prefixed to the serialized data). The default is SyncDestination, but these
can be easily toggled between using AsyncBincodeWriter::for_async.
Methods
impl<W, T, D> AsyncBincodeWriter<W, T, D>[src]
pub fn get_ref(&self) -> &W[src]
Gets a reference to the underlying writer.
It is inadvisable to directly write to the underlying writer.
pub fn get_mut(&mut self) -> &mut W[src]
Gets a mutable reference to the underlying writer.
It is inadvisable to directly write to the underlying writer.
pub fn into_inner(self) -> W[src]
Unwraps this AsyncBincodeWriter, returning the underlying writer.
Note that any leftover serialized data that has not yet been sent is lost.
impl<W, T> AsyncBincodeWriter<W, T, SyncDestination>[src]
pub fn for_async(self) -> AsyncBincodeWriter<W, T, AsyncDestination>[src]
Make this writer include the serialized data's size before each serialized value.
This is necessary for compatability with [AsyncBincodeReader].
impl<W, T> AsyncBincodeWriter<W, T, AsyncDestination>[src]
pub fn for_sync(self) -> AsyncBincodeWriter<W, T, SyncDestination>[src]
Make this writer only send bincode-encoded values.
This is necessary for compatability with stock bincode receivers.
Trait Implementations
impl<W, T> From<W> for AsyncBincodeWriter<W, T, SyncDestination>[src]
impl<W, T> Default for AsyncBincodeWriter<W, T, SyncDestination> where
W: Default, [src]
W: Default,
impl<W, T, D> Unpin for AsyncBincodeWriter<W, T, D> where
W: Unpin, [src]
W: Unpin,
impl<W: Debug, T: Debug, D: Debug> Debug for AsyncBincodeWriter<W, T, D>[src]
impl<W, T, D> Sink<T> for AsyncBincodeWriter<W, T, D> where
T: Serialize,
W: AsyncWrite + Unpin,
Self: BincodeWriterFor<T>, [src]
T: Serialize,
W: AsyncWrite + Unpin,
Self: BincodeWriterFor<T>,
type Error = Error
The type of value produced by the sink when an error occurs.
fn poll_ready(
self: Pin<&mut Self>,
_: &mut Context
) -> Poll<Result<(), Self::Error>>[src]
self: Pin<&mut Self>,
_: &mut Context
) -> Poll<Result<(), Self::Error>>
fn start_send(self: Pin<&mut Self>, item: T) -> Result<(), Self::Error>[src]
fn poll_flush(
self: Pin<&mut Self>,
cx: &mut Context
) -> Poll<Result<(), Self::Error>>[src]
self: Pin<&mut Self>,
cx: &mut Context
) -> Poll<Result<(), Self::Error>>
fn poll_close(
self: Pin<&mut Self>,
cx: &mut Context
) -> Poll<Result<(), Self::Error>>[src]
self: Pin<&mut Self>,
cx: &mut Context
) -> Poll<Result<(), Self::Error>>
Auto Trait Implementations
impl<W, T, D> Sync for AsyncBincodeWriter<W, T, D> where
D: Sync,
T: Sync,
W: Sync,
D: Sync,
T: Sync,
W: Sync,
impl<W, T, D> Send for AsyncBincodeWriter<W, T, D> where
D: Send,
T: Send,
W: Send,
D: Send,
T: Send,
W: Send,
impl<W, T, D> UnwindSafe for AsyncBincodeWriter<W, T, D> where
D: UnwindSafe,
T: UnwindSafe,
W: UnwindSafe,
D: UnwindSafe,
T: UnwindSafe,
W: UnwindSafe,
impl<W, T, D> RefUnwindSafe for AsyncBincodeWriter<W, T, D> where
D: RefUnwindSafe,
T: RefUnwindSafe,
W: RefUnwindSafe,
D: RefUnwindSafe,
T: RefUnwindSafe,
W: RefUnwindSafe,
Blanket Implementations
impl<T> From<T> for T[src]
impl<T, U> Into<U> for T where
U: From<T>, [src]
U: From<T>,
impl<T, U> TryFrom<U> for T where
U: Into<T>, [src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>, [src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>[src]
impl<T> Borrow<T> for T where
T: ?Sized, [src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized, [src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T[src]
impl<T> Any for T where
T: 'static + ?Sized, [src]
T: 'static + ?Sized,
impl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized, [src]
T: Sink<Item> + ?Sized,
fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
E: From<Self::Error>,
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>, [src]
E: From<Self::Error>,
F: FnMut(U) -> Fut,
Fut: Future<Output = Result<Item, E>>,
fn with_flat_map<U, St, F>(self, f: F) -> WithFlatMap<Self, Item, U, St, F> where
F: FnMut(U) -> St,
St: Stream<Item = Result<Item, Self::Error>>, [src]
F: FnMut(U) -> St,
St: Stream<Item = Result<Item, Self::Error>>,
fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E, [src]
F: FnOnce(Self::Error) -> E,
fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self::Error: Into<E>, [src]
Self::Error: Into<E>,
fn buffer(self, capacity: usize) -> Buffer<Self, Item>[src]
fn close(&mut self) -> Close<Self, Item> where
Self: Unpin, [src]
Self: Unpin,
fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
Item: Clone,
Si: Sink<Item, Error = Self::Error>, [src]
Item: Clone,
Si: Sink<Item, Error = Self::Error>,
fn flush(&mut self) -> Flush<Self, Item> where
Self: Unpin, [src]
Self: Unpin,
fn send(&mut self, item: Item) -> Send<Self, Item> where
Self: Unpin, [src]
Self: Unpin,
fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where
Self: Unpin,
St: Stream<Item = Item> + Unpin, [src]
Self: Unpin,
St: Stream<Item = Item> + Unpin,
fn left_sink<Si2>(self) -> Either<Self, Si2> where
Si2: Sink<Item, Error = Self::Error>, [src]
Si2: Sink<Item, Error = Self::Error>,
fn right_sink<Si1>(self) -> Either<Si1, Self> where
Si1: Sink<Item, Error = Self::Error>, [src]
Si1: Sink<Item, Error = Self::Error>,