async-callback-manager 0.1.0

Library that provides an interface to create and manage asynchronous callbacks in Rust. Dependency of `youtui` music player.
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

use futures::{Future, Stream};
use std::any::Any;
#[cfg(feature = "task-debug")]
use std::fmt::Debug;

mod adaptors;
mod constraint;
mod error;
mod manager;
mod panicking_receiver_stream;
mod task;

pub use adaptors::*;
pub use constraint::*;
pub use error::*;
pub use manager::task_list::{TaskInformation, TaskOutcome};
pub use manager::*;
pub use panicking_receiver_stream::*;
pub use task::AsyncTask;
pub use task::dyn_task::NoOpHandler;

// Size of the channel used for each stream task.
// In future, this could be settable.
pub(crate) const DEFAULT_STREAM_CHANNEL_SIZE: usize = 20;

/// A task of kind T that can be run on a backend, returning a future of output
/// Output. The type must implement Any, as the
/// TypeId is used as part of the task management process.
pub trait BackendTask<Bkend>: Send + Any + OptPartialEq + OptDebug {
    type Output: Send;
    type MetadataType: PartialEq;
    fn into_future(self, backend: &Bkend) -> impl Future<Output = Self::Output> + Send + 'static;
    /// Metadata provides a way of grouping different tasks for use in
    /// constraints, if you override the default implementation.
    fn metadata() -> Vec<Self::MetadataType> {
        vec![]
    }
}

/// A task of kind T that can be run on a backend, returning a stream of outputs
/// Output. The type must implement Any, as the TypeId is used as part of the
/// task management process.
pub trait BackendStreamingTask<Bkend>: Send + Any + OptPartialEq + OptDebug {
    type Output: Send;
    type MetadataType: PartialEq;
    fn into_stream(
        self,
        backend: &Bkend,
    ) -> impl Stream<Item = Self::Output> + Send + Unpin + 'static;
    /// Metadata provides a way of grouping different tasks for use in
    /// constraints, if you override the default implementation.
    fn metadata() -> Vec<Self::MetadataType> {
        vec![]
    }
}

/// Represents the handler for a task output.
pub trait TaskHandler<Input, Frntend, Bkend, Md>: OptPartialEq + OptDebug {
    fn handle(self, input: Input) -> impl FrontendEffect<Frntend, Bkend, Md>;
}

/// Represents a mutation that can be applied to some state, returning an
/// effect.
pub trait FrontendEffect<Frntend, Bkend, Md> {
    fn apply(self, target: &mut Frntend) -> impl Into<AsyncTask<Frntend, Bkend, Md>>;
}

// Crate user require using features that key traits will require PartialEq or
// Debug. In return, the AsyncTask type will also implement PartialEq and Debug.
// Feature(where_clauses) on nightly would simplify this as traits themself
// could contain the cfg directives an a where Self: clause.
#[cfg(not(feature = "task-equality"))]
pub trait OptPartialEq {}
#[cfg(feature = "task-equality")]
pub trait OptPartialEq: PartialEq {}
#[cfg(not(feature = "task-debug"))]
pub trait OptDebug {}
#[cfg(feature = "task-debug")]
pub trait OptDebug: Debug {}
#[cfg(feature = "task-debug")]
impl<T: Debug> OptDebug for T {}
#[cfg(not(feature = "task-debug"))]
impl<T> OptDebug for T {}
#[cfg(feature = "task-equality")]
impl<T: PartialEq> OptPartialEq for T {}
#[cfg(not(feature = "task-equality"))]
impl<T> OptPartialEq for T {}