[−][src]Struct futures::stream::SplitSink

[+] Show declaration

pub struct SplitSink<S, Item> where
    S: Sink<Item>,  { /* fields omitted */ }

[−]

A Sink part of the split pair

Methods

`impl<S, Item> SplitSink<S, Item> where S: Unpin + Sink<Item>,` [src][−]

`pub fn reunite(self, other: SplitStream<S>) -> Result<S, ReuniteError<S, Item>>`[src][+]

Attempts to put the two "halves" of a split Stream + Sink back together. Succeeds only if the SplitStream<S> and SplitSink<S> are a matching pair originating from the same call to Stream::split.

Trait Implementations

`impl<S, Item> Unpin for SplitSink<S, Item> where S: Sink<Item>,` [src]

`impl<S, Item> Debug for SplitSink<S, Item> where Item: Debug, S: Debug + Sink<Item>,` [src][+]

[+] Show hidden undocumented items

`fn fmt(&self, f: &mut Formatter) -> Result<(), Error>`[src][+]

`impl<S, Item> Sink<Item> for SplitSink<S, Item> where S: Sink<Item>,` [src][+]

[+] Show hidden undocumented items

`type SinkError = <S as Sink<Item>>::SinkError`

The type of value produced by the sink when an error occurs.

`fn poll_ready( self: Pin<&mut SplitSink<S, Item>>, cx: &mut Context ) -> Poll<Result<(), <S as Sink<Item>>::SinkError>>`[src][+]

`fn start_send( self: Pin<&mut SplitSink<S, Item>>, item: Item ) -> Result<(), <S as Sink<Item>>::SinkError>`[src][+]

`fn poll_flush( self: Pin<&mut SplitSink<S, Item>>, cx: &mut Context ) -> Poll<Result<(), <S as Sink<Item>>::SinkError>>`[src][+]

`fn poll_close( self: Pin<&mut SplitSink<S, Item>>, cx: &mut Context ) -> Poll<Result<(), <S as Sink<Item>>::SinkError>>`[src][+]

Auto Trait Implementations

`impl<S, Item> Send for SplitSink<S, Item> where Item: Send, S: Send,`

`impl<S, Item> Sync for SplitSink<S, Item> where Item: Sync, S: Send,`

Blanket Implementations

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

[+] Show hidden undocumented items

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

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

[+] Show hidden undocumented items

`fn into(self) -> U`[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.

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

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

[+] Show hidden undocumented items

ⓘImportant traits for &'_ mut F
Important traits for &'_ mut F
`impl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
`fn borrow(&self) -> &T`[src][+]

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

[+] Show hidden undocumented items

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

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

[+] Show hidden undocumented items

ⓘImportant traits for &'_ mut F
Important traits for &'_ mut F
`impl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
`fn borrow_mut(&mut self) -> &mut T`[src][+]

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

[+] Show hidden undocumented items

`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, Item> SinkExt for T where T: Sink<Item> + ?Sized,` [src][+]

`fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where E: From<Self::SinkError>, F: FnMut(U) -> Fut, Fut: Future<Output = Result<Item, E>>,` [src][+]

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

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::SinkError) -> E,` [src][+]

Transforms the error returned by the sink.

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

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

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

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

ⓘImportant traits for Close<'_, Si, Item>
Important traits for Close<'_, Si, Item>
`impl<'_, Si, Item> Future for Close<'_, Si, Item> where Si: Unpin + Sink<Item> + ?Sized, type Output = Result<(), <Si as Sink<Item>>::SinkError>;`
`fn close(&mut self) -> Close<Self, Item> where Self: Unpin,` [src][+]

Close the sink.

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

Fanout items to multiple sinks. Read more

ⓘImportant traits for Flush<'_, Si, Item>
Important traits for Flush<'_, Si, Item>
`impl<'_, Si, Item> Future for Flush<'_, Si, Item> where Si: Unpin + Sink<Item> + ?Sized, type Output = Result<(), <Si as Sink<Item>>::SinkError>;`
`fn flush(&mut self) -> Flush<Self, Item> where Self: Unpin,` [src][+]

Flush the sync, processing all pending items. Read more

ⓘImportant traits for Send<'_, Si, Item>
Important traits for Send<'_, Si, Item>
`impl<'_, Si, Item> Future for Send<'_, Si, Item> where Si: Unpin + Sink<Item> + ?Sized, type Output = Result<(), <Si as Sink<Item>>::SinkError>;`
`fn send(&mut self, item: Item) -> Send<Self, Item> where Self: Unpin,` [src][+]

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

ⓘImportant traits for SendAll<'_, Si, St>
Important traits for SendAll<'_, Si, St>
`impl<'_, Si, St> Future for SendAll<'_, Si, St> where Si: Sink<<St as Stream>::Item> + Unpin + ?Sized, St: Stream + Unpin + ?Sized, type Output = Result<(), <Si as Sink<<St as Stream>::Item>>::SinkError>;`
`fn send_all<St>(&'a mut self, stream: &'a mut St) -> SendAll<'a, Self, St> where Self: Unpin, St: Stream<Item = Item> + Unpin,` [src][+]

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

ⓘImportant traits for Either<A, B>
Important traits for Either<A, B>
`impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output;`
`fn left_sink<Si2>(self) -> Either<Self, Si2> where Si2: Sink<Item, SinkError = Self::SinkError>,` [src][+]

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

ⓘImportant traits for Either<A, B>
Important traits for Either<A, B>
`impl<A, B> Future for Either<A, B> where A: Future, B: Future<Output = <A as Future>::Output>, type Output = <A as Future>::Output;`
`fn right_sink<Si1>(self) -> Either<Si1, Self> where Si1: Sink<Item, SinkError = Self::SinkError>,` [src][+]

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

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

Wraps a [Sink] into a sink compatible with libraries using futures 0.1 Sink. Requires the compat feature to be enabled. Read more

[−][src]Struct futures::stream::SplitSink

Methods

impl<S, Item> SplitSink<S, Item> where S: Unpin + Sink<Item>, [src][−]

pub fn reunite(self, other: SplitStream<S>) -> Result<S, ReuniteError<S, Item>>[src][+]

Trait Implementations

impl<S, Item> Unpin for SplitSink<S, Item> where S: Sink<Item>, [src]

impl<S, Item> Debug for SplitSink<S, Item> where Item: Debug, S: Debug + Sink<Item>, [src][+]

fn fmt(&self, f: &mut Formatter) -> Result<(), Error>[src][+]

impl<S, Item> Sink<Item> for SplitSink<S, Item> where S: Sink<Item>, [src][+]

type SinkError = <S as Sink<Item>>::SinkError

fn poll_ready( self: Pin<&mut SplitSink<S, Item>>, cx: &mut Context) -> Poll<Result<(), <S as Sink<Item>>::SinkError>>[src][+]

fn start_send( self: Pin<&mut SplitSink<S, Item>>, item: Item) -> Result<(), <S as Sink<Item>>::SinkError>[src][+]

fn poll_flush( self: Pin<&mut SplitSink<S, Item>>, cx: &mut Context) -> Poll<Result<(), <S as Sink<Item>>::SinkError>>[src][+]

fn poll_close( self: Pin<&mut SplitSink<S, Item>>, cx: &mut Context) -> Poll<Result<(), <S as Sink<Item>>::SinkError>>[src][+]

Auto Trait Implementations

impl<S, Item> Send for SplitSink<S, Item> where Item: Send, S: Send,

impl<S, Item> Sync for SplitSink<S, Item> where Item: Sync, S: Send,

Blanket Implementations

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

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

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

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

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

type Error = Infallible

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

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

ⓘImportant traits for &'_ mut FImportant traits for &'_ mut Fimpl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;fn borrow(&self) -> &T[src][+]

Important traits for &'_ mut F

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

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

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

ⓘImportant traits for &'_ mut FImportant traits for &'_ mut Fimpl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;fn borrow_mut(&mut self) -> &mut T[src][+]

Important traits for &'_ mut F

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

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

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

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

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

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

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

fn sink_err_into<E>(self) -> SinkErrInto<Self, Item, E> where Self::SinkError: Into<E>, [src][+]

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

ⓘImportant traits for Close<'_, Si, Item>Important traits for Close<'_, Si, Item>impl<'_, Si, Item> Future for Close<'_, Si, Item> where Si: Unpin + Sink<Item> + ?Sized, type Output = Result<(), <Si as Sink<Item>>::SinkError>;fn close(&mut self) -> Close<Self, Item> where Self: Unpin, [src][+]

Important traits for Close<'_, Si, Item>

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

ⓘImportant traits for Flush<'_, Si, Item>Important traits for Flush<'_, Si, Item>impl<'_, Si, Item> Future for Flush<'_, Si, Item> where Si: Unpin + Sink<Item> + ?Sized, type Output = Result<(), <Si as Sink<Item>>::SinkError>;fn flush(&mut self) -> Flush<Self, Item> where Self: Unpin, [src][+]

Important traits for Flush<'_, Si, Item>

Important traits for Send<'_, Si, Item>

Important traits for SendAll<'_, Si, St>

Important traits for Either<A, B>

Important traits for Either<A, B>

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

`impl<S, Item> SplitSink<S, Item> where S: Unpin + Sink<Item>,` [src][−]

`pub fn reunite(self, other: SplitStream<S>) -> Result<S, ReuniteError<S, Item>>`[src][+]

`impl<S, Item> Unpin for SplitSink<S, Item> where S: Sink<Item>,` [src]

`impl<S, Item> Debug for SplitSink<S, Item> where Item: Debug, S: Debug + Sink<Item>,` [src][+]

`fn fmt(&self, f: &mut Formatter) -> Result<(), Error>`[src][+]

`impl<S, Item> Sink<Item> for SplitSink<S, Item> where S: Sink<Item>,` [src][+]

`type SinkError = <S as Sink<Item>>::SinkError`

`fn poll_ready( self: Pin<&mut SplitSink<S, Item>>, cx: &mut Context ) -> Poll<Result<(), <S as Sink<Item>>::SinkError>>`[src][+]

`fn start_send( self: Pin<&mut SplitSink<S, Item>>, item: Item ) -> Result<(), <S as Sink<Item>>::SinkError>`[src][+]

`fn poll_flush( self: Pin<&mut SplitSink<S, Item>>, cx: &mut Context ) -> Poll<Result<(), <S as Sink<Item>>::SinkError>>`[src][+]

`fn poll_close( self: Pin<&mut SplitSink<S, Item>>, cx: &mut Context ) -> Poll<Result<(), <S as Sink<Item>>::SinkError>>`[src][+]

`impl<S, Item> Send for SplitSink<S, Item> where Item: Send, S: Send,`

`impl<S, Item> Sync for SplitSink<S, Item> where Item: Sync, S: Send,`

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

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

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

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

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

`type Error = Infallible`

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

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

ⓘImportant traits for &'_ mut F
Important traits for &'_ mut F
`impl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
`fn borrow(&self) -> &T`[src][+]

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

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

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

ⓘImportant traits for &'_ mut F
Important traits for &'_ mut F
`impl<'_, F> Future for &'_ mut F where F: Unpin + Future + ?Sized, type Output = <F as Future>::Output;`
`fn borrow_mut(&mut self) -> &mut T`[src][+]

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

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

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

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

`fn with<U, Fut, F, E>(self, f: F) -> With<Self, Item, U, Fut, F> where E: From<Self::SinkError>, F: FnMut(U) -> Fut, Fut: Future<Output = Result<Item, E>>,` [src][+]

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

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

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

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

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

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