indicator 0.4.4

Abstractions for stream aggregation, we call them `Indicator` s.
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
30
31
32
33
34
35
36
37
38
39
40
41
42
43

use super::error::StreamError;
use core::{
    pin::Pin,
    task::{Context, Poll},
};

pub use self::{sink::sink_with_shutdown, unbounded::unbounded};

/// Unbounded Subscriber.
pub mod unbounded;

/// Sink Subscriber.
pub mod sink;

#[cfg(not(feature = "send"))]
/// Subscriber.
pub trait Subscriber<I> {
    /// Poll ready.
    fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<bool, StreamError>>;
    /// Feed next item.
    fn start_send(self: Pin<&mut Self>, item: I) -> Result<(), StreamError>;
    /// Poll flush.
    fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<bool, StreamError>>;
    /// Closing.
    fn closing(self: Pin<&mut Self>, reason: Result<(), StreamError>) -> Result<(), StreamError>;
    /// Poll close.
    fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), StreamError>>;
}

#[cfg(feature = "send")]
/// Subscriber.
pub trait Subscriber<I>: Send {
    /// Poll ready.
    fn poll_ready(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<bool, StreamError>>;
    /// Feed next item.
    fn start_send(self: Pin<&mut Self>, item: I) -> Result<(), StreamError>;
    /// Poll flush.
    fn poll_flush(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<bool, StreamError>>;
    /// Closing.
    fn closing(self: Pin<&mut Self>, reason: Result<(), StreamError>) -> Result<(), StreamError>;
    /// Poll close.
    fn poll_close(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<Result<(), StreamError>>;
}