Struct grpcio::ServerStreamingSink[−][src]

[+] Show declaration

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

[−]

A sink for server streaming call.

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

Implementations

`impl<T> ServerStreamingSink<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) -> ServerStreamingSinkFailureⓘNotable traits for ServerStreamingSinkFailure impl Future for ServerStreamingSinkFailure type Output = Result<()>;`[src]

Trait Implementations

`impl<T> Drop for ServerStreamingSink<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 ServerStreamingSink<T>`[src][+]

[+] Show hidden undocumented items

`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 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,` [src][+]

[+] Show hidden undocumented items

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

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

[+] Show hidden undocumented items

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

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

[+] Show hidden undocumented items

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

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

[+] Show hidden undocumented items

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

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

[+] Show hidden undocumented items

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

`impl<T, Item> SinkExt<Item> for T where T: Sink<Item> + ?Sized,` [src][+]

[+] Show hidden undocumented items

`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][−]

`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][−]

`pub fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where F: FnOnce(Self::Error) -> E,` [src][−]

`pub fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where Self::Error: Into<E>,` [src][−]

`pub fn buffer(self, capacity: usize) -> Buffer<Self, Item>`[src][−]

`pub fn close(&mut self) -> Close<'_, Self, Item> where Self: Unpin,` [src][−]

`pub fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where Item: Clone, Si: Sink<Item, Error = Self::Error>,` [src][−]

`pub fn flush(&mut self) -> Flush<'_, Self, Item> where Self: Unpin,` [src][−]

`pub fn send(&mut self, item: Item) -> Send<'_, Self, Item> where Self: Unpin,` [src][−]

`pub fn feed(&mut self, item: Item) -> Feed<'_, Self, Item> where Self: Unpin,` [src][−]

`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][−]

`pub fn left_sink<Si2>(self) -> Either<Self, Si2> where Si2: Sink<Item, Error = Self::Error>,` [src][−]

`pub fn right_sink<Si1>(self) -> Either<Si1, Self> where Si1: Sink<Item, Error = Self::Error>,` [src][−]

`pub fn compat(self) -> CompatSink<Self, Item> where Self: Unpin,` [src][−]

`pub fn poll_ready_unpin( &mut self, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>> where Self: Unpin,` [src][−]

`pub fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where Self: Unpin,` [src][−]

`pub fn poll_flush_unpin( &mut self, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>> where Self: Unpin,` [src][−]

`pub fn poll_close_unpin( &mut self, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>> where Self: Unpin,` [src][−]

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

[+] Show hidden undocumented items

`type Error = Infallible`

The type returned in the event of a conversion error.

`pub fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>`[src][−]

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

[+] Show hidden undocumented items

`type Error = >::Error`

The type returned in the event of a conversion error.

Struct grpcio::ServerStreamingSink⎘[−][src]

Implementations

impl<T> ServerStreamingSink<T>[src][−]

pub fn enhance_batch(&mut self, flag: bool)[src][−]

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

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

Notable traits for ServerStreamingSinkFailure

Trait Implementations

impl<T> Drop for ServerStreamingSink<T>[src][+]

fn drop(&mut self)[src][−]

impl<T> Sink<(T, WriteFlags)> for ServerStreamingSink<T>[src][+]

type Error = Error

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 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, [src][+]

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

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

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

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

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

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

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

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

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

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

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][−]

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][−]

pub fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where F: FnOnce(Self::Error) -> E, [src][−]

pub fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where Self::Error: Into<E>, [src][−]

pub fn buffer(self, capacity: usize) -> Buffer<Self, Item>[src][−]

pub fn close(&mut self) -> Close<'_, Self, Item> where Self: Unpin, [src][−]

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

pub fn flush(&mut self) -> Flush<'_, Self, Item> where Self: Unpin, [src][−]

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

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

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][−]

pub fn left_sink<Si2>(self) -> Either<Self, Si2> where Si2: Sink<Item, Error = Self::Error>, [src][−]

pub fn right_sink<Si1>(self) -> Either<Si1, Self> where Si1: Sink<Item, Error = Self::Error>, [src][−]

pub fn compat(self) -> CompatSink<Self, Item> where Self: Unpin, [src][−]

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

pub fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where Self: Unpin, [src][−]

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

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

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

type Error = Infallible

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][+]

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

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

Struct grpcio::ServerStreamingSink[−][src]

`impl<T> ServerStreamingSink<T>`[src][−]

`pub fn enhance_batch(&mut self, flag: bool)`[src][−]

`pub fn set_status(&mut self, status: RpcStatus)`[src]

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

`impl<T> Drop for ServerStreamingSink<T>`[src][+]

`fn drop(&mut self)`[src][−]

`impl<T> Sink<(T, WriteFlags)> for ServerStreamingSink<T>`[src][+]

`type Error = Error`

`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][−]

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

`impl<T> Any for T where T: 'static + ?Sized,` [src][+]

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

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

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

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

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

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

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

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

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

`impl<T, Item> SinkExt<Item> for T where T: Sink<Item> + ?Sized,` [src][+]

`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][−]

`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][−]

`pub fn sink_map_err<E, F>(self, f: F) -> SinkMapErr<Self, F> where F: FnOnce(Self::Error) -> E,` [src][−]

`pub fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where Self::Error: Into<E>,` [src][−]

`pub fn buffer(self, capacity: usize) -> Buffer<Self, Item>`[src][−]

`pub fn close(&mut self) -> Close<'_, Self, Item> where Self: Unpin,` [src][−]

`pub fn fanout<Si>(self, other: Si) -> Fanout<Self, Si> where Item: Clone, Si: Sink<Item, Error = Self::Error>,` [src][−]

`pub fn flush(&mut self) -> Flush<'_, Self, Item> where Self: Unpin,` [src][−]

`pub fn send(&mut self, item: Item) -> Send<'_, Self, Item> where Self: Unpin,` [src][−]

`pub fn feed(&mut self, item: Item) -> Feed<'_, Self, Item> where Self: Unpin,` [src][−]

`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][−]

`pub fn left_sink<Si2>(self) -> Either<Self, Si2> where Si2: Sink<Item, Error = Self::Error>,` [src][−]

`pub fn right_sink<Si1>(self) -> Either<Si1, Self> where Si1: Sink<Item, Error = Self::Error>,` [src][−]

`pub fn compat(self) -> CompatSink<Self, Item> where Self: Unpin,` [src][−]

`pub fn poll_ready_unpin( &mut self, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>> where Self: Unpin,` [src][−]

`pub fn start_send_unpin(&mut self, item: Item) -> Result<(), Self::Error> where Self: Unpin,` [src][−]

`pub fn poll_flush_unpin( &mut self, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>> where Self: Unpin,` [src][−]

`pub fn poll_close_unpin( &mut self, cx: &mut Context<'_> ) -> Poll<Result<(), Self::Error>> where Self: Unpin,` [src][−]

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

`type Error = Infallible`

`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][+]

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

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