futuristic 0.5.0

Extensions to the futures crate
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29

// Copyright (C) 2018-2022 Stephane Raux. Distributed under the 0BSD license.

//! Tools for sinks

use either::Either;
use futures::Sink;

pub use fork::Fork;

mod fork;

/// Extension trait for [`Sink`](futures::Sink).
pub trait SinkTools<T>: Sink<T> {
    /// Returns a sink that dispatches to `self` or `other`.
    ///
    /// Every item sent to the returned sink is passed to `switch` and the returned value is sent
    /// to one of the underlying sinks. `Left` values are sent to `self` while `Right` values are
    /// sent to `other`.
    fn fork<V, O, F, U>(self, other: O, switch: F) -> Fork<V, Self, O, F, T, U>
    where
        Self: Sized,
        F: FnMut(V) -> Either<T, U>,
        O: Sink<U, Error = Self::Error>,
    {
        Fork::new(self, other, switch)
    }
}

impl<T, S: Sink<T>> SinkTools<T> for S {}