Struct grpcio::ServerStreamingSink

source · [−]

pub struct ServerStreamingSink<T> { /* private fields */ }

Expand description

A sink for server streaming call.

To close the sink properly, you should call close or fail before dropping.

Implementations

source

impl<T> ServerStreamingSink<T>

source

pub fn set_headers(&mut self, meta: Metadata)

source

pub fn enhance_batch(&mut self, flag: bool)

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.

source

pub fn set_status(&mut self, status: RpcStatus)

source

pub fn fail(self, status: RpcStatus) -> ServerStreamingSinkFailureⓘNotable traits for ServerStreamingSinkFailure`impl Future for ServerStreamingSinkFailure type Output = Result<()>;`

Trait Implementations

source

impl<T> Drop for ServerStreamingSink<T>

source

fn drop(&mut self)

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

source

impl<T> Sink<(T, WriteFlags )> for ServerStreamingSink<T>

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<()>>

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

source

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

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<()>>

Flush any remaining output from this sink. Read more

source

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

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

Auto Trait Implementations

impl<T> !RefUnwindSafe for ServerStreamingSink<T>

impl<T> Send for ServerStreamingSink<T>

impl<T> !Sync for ServerStreamingSink<T>

impl<T> Unpin for ServerStreamingSink<T>

impl<T> !UnwindSafe for ServerStreamingSink<T>

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for T where
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for T where
U: From<T>,

const: unstable · 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, Item> SinkExt<Item> for T where
T: Sink<Item> + ?Sized,

source

fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where
 F: FnMut(U) -> Fut,
 Fut: Future<Output = Result<Item, E>>,
 E: From<Self::Error>,

Composes a function in front of the sink. Read more

source

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

source

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.

source

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

source

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

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

source

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

Close the sink.

source

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

source

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

Flush the sink, processing all pending items. Read more

source

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

source

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

source

fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
Self: Unpin,

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

source

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

source

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

source

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

source

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

source

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

source

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

source

impl<T, U> TryFrom for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for T where
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

Struct grpcio::ServerStreamingSink

Implementations

impl<T> ServerStreamingSink<T>

pub fn set_headers(&mut self, meta: Metadata)

pub fn enhance_batch(&mut self, flag: bool)

pub fn set_status(&mut self, status: RpcStatus)

pub fn fail(self, status: RpcStatus) -> ServerStreamingSinkFailureⓘNotable traits for ServerStreamingSinkFailureimpl Future for ServerStreamingSinkFailure type Output = Result<()>;

Trait Implementations

impl<T> Drop for ServerStreamingSink<T>

fn drop(&mut self)

impl<T> Sink<(T, WriteFlags)> for ServerStreamingSink<T>

type Error = Error

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

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

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

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

Auto Trait Implementations

impl<T> !RefUnwindSafe for ServerStreamingSink<T>

impl<T> Send for ServerStreamingSink<T>

impl<T> !Sync for ServerStreamingSink<T>

impl<T> Unpin for ServerStreamingSink<T>

impl<T> !UnwindSafe for ServerStreamingSink<T>

Blanket Implementations

impl<T> Any for T where T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for T where T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for T where T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for T where U: From<T>,

fn into(self) -> U

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, Fut: Future<Output = Result<Item, E>>, E: From<Self::Error>,

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

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

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

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

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

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

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

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

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

fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized, Self: Unpin,

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

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

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

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

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

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

impl<T, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for T where U: TryFrom<T>,

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

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

pub fn fail(self, status: RpcStatus) -> ServerStreamingSinkFailureⓘNotable traits for ServerStreamingSinkFailure`impl Future for ServerStreamingSinkFailure type Output = Result<()>;`

impl<T> Sink<(T, WriteFlags )> for ServerStreamingSink<T>

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

impl<T> Any for T where
T: 'static + ?Sized,

impl<T> Borrow<T> for T where
T: ?Sized,

impl<T> BorrowMut<T> for T where
T: ?Sized,

impl<T, U> Into<U> for T where
U: From<T>,

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,
Fut: Future<Output = Result<Item, E>>,
E: From<Self::Error>,

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

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

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

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

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

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

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

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

fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where
St: TryStream<Ok = Item, Error = Self::Error> + Stream + Unpin + ?Sized,
Self: Unpin,

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

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

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

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

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

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

impl<T, U> TryFrom<U> for T where
U: Into<T>,

impl<T, U> TryInto<U> for T where
U: TryFrom<T>,