Struct grpcio::DuplexSink [−][src]
A sink for duplex streaming call.
To close the sink properly, you should call close
or fail
before dropping.
Implementations
impl<T> DuplexSink<T>
[src]
pub fn enhance_batch(&mut self, flag: bool)
[src]
By default it always sends messages with their configured buffer hint. But when the
enhance_batch
is enabled, messages will be batched together as many as possible.
The rules are listed as below:
- All messages except the last one will be sent with
buffer_hint
set to true. - The last message will also be sent with
buffer_hint
set to true unless any message is offered with buffer hint set to false.
No matter enhance_batch
is true or false, it’s recommended to follow the contract of
Sink and call poll_flush
to ensure messages are handled by gRPC C Core.
pub fn set_status(&mut self, status: RpcStatus)
[src]
pub fn fail(self, status: RpcStatus) -> DuplexSinkFailureⓘNotable traits for DuplexSinkFailure
impl Future for DuplexSinkFailure type Output = Result<()>;
[src]
Notable traits for DuplexSinkFailure
impl Future for DuplexSinkFailure type Output = Result<()>;
Trait Implementations
impl<T> Drop for DuplexSink<T>
[src]
impl<T> Sink<(T, WriteFlags)> for DuplexSink<T>
[src]
type Error = Error
The type of value produced by the sink when an error occurs.
fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>
[src]
fn start_send(self: Pin<&mut Self>, (msg, flags): (T, WriteFlags)) -> Result<()>
[src]
fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>
[src]
fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<()>>
[src]
Auto Trait Implementations
impl<T> !RefUnwindSafe for DuplexSink<T>
impl<T> Send for DuplexSink<T>
impl<T> Sync for DuplexSink<T>
impl<T> Unpin for DuplexSink<T>
impl<T> !UnwindSafe for DuplexSink<T>
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,
[src]
T: Sink<Item> + ?Sized,
pub fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
F: FnMut(U) -> Fut,
E: From<Self::Error>,
Fut: Future<Output = Result<Item, E>>,
[src]
F: FnMut(U) -> Fut,
E: From<Self::Error>,
Fut: Future<Output = Result<Item, E>>,
pub 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>>,
pub fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
F: FnOnce(Self::Error) -> E,
[src]
F: FnOnce(Self::Error) -> E,
pub fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
Self::Error: Into<E>,
[src]
Self::Error: Into<E>,
pub fn buffer(self, capacity: usize) -> Buffer<Self, Item>
[src]
pub fn close(&mut self) -> Close<'_, Self, Item> where
Self: Unpin,
[src]
Self: Unpin,
pub 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>,
pub fn flush(&mut self) -> Flush<'_, Self, Item> where
Self: Unpin,
[src]
Self: Unpin,
pub fn send(&mut self, item: Item) -> Send<'_, Self, Item> where
Self: Unpin,
[src]
Self: Unpin,
pub fn feed(&mut self, item: Item) -> Feed<'_, Self, Item> where
Self: Unpin,
[src]
Self: Unpin,
pub fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where
Self: Unpin,
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
[src]
Self: Unpin,
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
pub fn left_sink<Si2>(self) -> Either<Self, Si2> where
Si2: Sink<Item, Error = Self::Error>,
[src]
Si2: Sink<Item, Error = Self::Error>,
pub fn right_sink<Si1>(self) -> Either<Si1, Self> where
Si1: Sink<Item, Error = Self::Error>,
[src]
Si1: Sink<Item, Error = Self::Error>,
pub fn compat(self) -> CompatSink<Self, Item> where
Self: Unpin,
[src]
Self: Unpin,
pub fn poll_ready_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
[src]
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
pub fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
Self: Unpin,
[src]
Self: Unpin,
pub fn poll_flush_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
[src]
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
pub fn poll_close_unpin(
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
[src]
&mut self,
cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
Self: Unpin,
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.
pub 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>,