Struct grpcio::DuplexSink[−][src]

#[must_use = "if unused the sink may immediately cancel the RPC"]
pub struct DuplexSink<T> { /* fields omitted */ }
Expand description

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]

Trait Implementations

impl<T> Drop for DuplexSink<T>[src]

fn drop(&mut self)[src]

The corresponding RPC will be canceled if the sink did not call close or fail before dropping.

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]

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

fn start_send(self: Pin<&mut Self>, (msg, flags): (T, WriteFlags)) -> Result<()>[src]

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

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

Flush any remaining output from this sink. Read more

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

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

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]

pub fn type_id(&self) -> TypeId[src]

Gets the TypeId of self. Read more

impl<T> Borrow<T> for T where
    T: ?Sized, [src]

pub fn borrow(&self) -> &T[src]

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for T where
    T: ?Sized, [src]

pub fn borrow_mut(&mut self) -> &mut T[src]

Mutably borrows from an owned value. Read more

impl<T> From<T> for T[src]

pub fn from(t: T) -> T[src]

Performs the conversion.

impl<T, U> Into<U> for T where
    U: From<T>, [src]

pub fn into(self) -> U[src]

Performs the conversion.

impl<T, Item> SinkExt<Item> for T where
    T: Sink<Item> + ?Sized, 

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>>, 

Composes a function in front of the sink. Read more

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>>, 

Composes a function in front of the sink. Read more

fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where
    F: FnOnce(Self::Error) -> E, 

Transforms the error returned by the sink.

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where
    Self::Error: Into<E>, 

Map this sink’s error to a different error type using the Into trait. Read more

fn buffer(self, capacity: usize) -> Buffer<Self, Item>

Adds a fixed-size buffer to the current sink. Read more

fn close(&mut self) -> Close<'_, Self, Item> where
    Self: Unpin, 

Close the sink.

fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where
    Item: Clone,
    Si: Sink<Item, Error = Self::Error>, 

Fanout items to multiple sinks. Read more

fn flush(&mut self) -> Flush<'_, Self, Item> where
    Self: Unpin, 

Flush the sink, processing all pending items. Read more

fn send(&mut self, item: Item) -> Send<'_, Self, Item> where
    Self: Unpin, 

A future that completes after the given item has been fully processed into the sink, including flushing. Read more

fn feed(&mut self, item: Item) -> Feed<'_, Self, Item> where
    Self: Unpin, 

A future that completes after the given item has been received by the sink. Read more

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, 

A future that completes after the given stream has been fully processed into the sink, including flushing. Read more

fn left_sink<Si2>(self) -> Either<Self, Si2> where
    Si2: Sink<Item, Error = Self::Error>, 

Wrap this sink in an Either sink, making it the left-hand variant of that Either. Read more

fn right_sink<Si1>(self) -> Either<Si1, Self> where
    Si1: Sink<Item, Error = Self::Error>, 

Wrap this stream in an Either stream, making it the right-hand variant of that Either. Read more

fn poll_ready_unpin(
    &mut self,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
    Self: Unpin, 

A convenience method for calling [Sink::poll_ready] on Unpin sink types. Read more

fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where
    Self: Unpin, 

A convenience method for calling [Sink::start_send] on Unpin sink types. Read more

fn poll_flush_unpin(
    &mut self,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
    Self: Unpin, 

A convenience method for calling [Sink::poll_flush] on Unpin sink types. Read more

fn poll_close_unpin(
    &mut self,
    cx: &mut Context<'_>
) -> Poll<Result<(), Self::Error>> where
    Self: Unpin, 

A convenience method for calling [Sink::poll_close] on Unpin sink types. Read more

impl<T, U> TryFrom<U> for T where
    U: Into<T>, [src]

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]

Performs the conversion.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, [src]

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

The type returned in the event of a conversion error.

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

Performs the conversion.