discro 0.35.0

DISCRete Observables for asynchronous Functional Reactive Programming (FRP).
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

// SPDX-FileCopyrightText: The discro authors
// SPDX-License-Identifier: MPL-2.0

//! Discrete observables for asynchronous *Functional Reactive Programming* (FRP).
//!
//! ## Crate Features
//!
//! One of the following (mutually exclusive) features must be enabled to select
//! a concrete implementation:
//!
//! - `tokio` implementation based on [`tokio::sync::watch`](https://docs.rs/tokio/latest/tokio/sync/watch/)

use thiserror::Error;

mod docs;

#[cfg(not(any(feature = "tokio")))]
pub use self::docs::*;

#[cfg(test)]
mod traits;

/// Return value of [`Publisher::modify`].
///
/// Allows to capture data from within the locking scope.
/// If the modification does not capture and return any data
/// then `bool` could be used.
pub trait ModifiedStatus {
    /// Indicates if the shared value has been modified.
    ///
    /// Returns `true` if the shared value has been modified
    /// by a publisher and subscribers need to be notified.
    /// Returns `false` if the shared value is unchanged.
    ///
    /// See also: `[Publisher::set_modified]`.
    fn is_modified(&self) -> bool;
}

impl ModifiedStatus for bool {
    fn is_modified(&self) -> bool {
        *self
    }
}

/// Indicates that the publisher has been dropped.
#[derive(Error, Debug)]
#[error("disconnected from publisher")]
pub struct OrphanedSubscriberError;

pub(crate) mod subscriber;

#[cfg(feature = "tokio")]
mod tokio;

#[cfg(feature = "tokio")]
pub use self::tokio::*;

#[cfg(feature = "async-stream")]
mod async_stream;

#[cfg(feature = "async-stream")]
pub use self::async_stream::*;

pub mod tasklet;