ruchei-callback 0.1.2

Callback traits for ruchei
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

#![no_std]

//! Callbacks used in [`ruchei`] stream adapters.
//!
//! Placed in a separate crate to improve compatibility across [`ruchei`] versions, since the bigger
//! crate is still at `0.0.X`, at the time of writing, and there are no plans of changing that yet.
//!
//! [`ruchei`]: https://docs.rs/ruchei/0.0.81/ruchei/index.html

/// Act when one of inner channels gets closed instead of closing the outer channel. Used with [`multicast`].
///
/// Deprecated in favour of [`MultiItem`].
///
/// [`multicast`]: https://docs.rs/ruchei/0.0.81/ruchei/multicast/index.html
/// [`MultiItem`]: https://docs.rs/ruchei/0.0.97/ruchei/multi_item/enum.MultiItem.html
#[deprecated]
#[must_use = "callbacks must be called"]
pub trait OnClose<E>: Clone {
    /// Get notified about something getting closed (optionally with an error).
    fn on_close(&self, error: Option<E>);
}

/// Implemented only for [`Sized`] because stored.
#[expect(deprecated)]
impl<E, F: Clone + Fn(Option<E>)> OnClose<E> for F {
    fn on_close(&self, error: Option<E>) {
        self(error)
    }
}

/// Used with [`ReadCallback`].
///
/// Deprecated: the combinator got removed.
///
/// [`ReadCallback`]: https://docs.rs/ruchei/0.0.81/ruchei/read_callback/index.html
#[deprecated]
#[must_use = "callbacks must be called"]
pub trait OnItem<T> {
    /// Receive an item.
    fn on_item(&self, message: T);
}

/// Implemented only for [`Sized`] because stored.
#[expect(deprecated)]
impl<T, F: Fn(T)> OnItem<T> for F {
    fn on_item(&self, message: T) {
        self(message)
    }
}

/// Start a timer [`Future`]. Used with [`TimeoutUnused`].
///
/// [`Future`]: core::future::Future
/// [`TimeoutUnused`]: https://docs.rs/ruchei/0.0.81/ruchei/timeout_unused/index.html
#[must_use = "callbacks must be called"]
pub trait Start {
    /// Future created by this factory.
    type Fut;

    /// Create the future (start a timer).
    #[must_use]
    fn make(&mut self) -> Self::Fut;
}

/// Implemented only for [`Sized`] because stored.
impl<Fut, F: FnMut() -> Fut> Start for F {
    type Fut = Fut;

    fn make(&mut self) -> Self::Fut {
        self()
    }
}