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 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171
//! Built-in handler description types.
mod interest_set;
mod unspecified;
pub use interest_set::{EventKind, InterestSet};
pub use unspecified::Unspecified;
/// Handler description.
///
/// This trait allows information to flow "back up" the tree, allowing to check
/// its structure.
///
/// ## Examples
///
/// Count how many branches are in the tree:
///
/// ```
/// use dptree::{prelude::DependencyMap, Handler, HandlerDescription};
///
/// struct CountBranches(u32);
///
/// impl HandlerDescription for CountBranches {
/// fn entry() -> Self {
/// Self(0)
/// }
///
/// fn user_defined() -> Self {
/// Self(0)
/// }
///
/// fn merge_chain(&self, other: &Self) -> Self {
/// Self(self.0 + other.0)
/// }
///
/// fn merge_branch(&self, other: &Self) -> Self {
/// Self(self.0 + other.0 + 1)
/// }
/// }
///
/// #[track_caller]
/// fn assert_count(count: u32, handler: Handler<DependencyMap, (), CountBranches>) {
/// assert_eq!(handler.description().0, count);
/// }
///
/// assert_count(0, dptree::entry());
/// assert_count(1, dptree::entry().branch(dptree::entry()));
/// assert_count(
/// 5,
/// dptree::entry()
/// .branch(
/// dptree::entry()
/// .branch(dptree::entry().branch(dptree::filter(|| true)))
/// .branch(dptree::entry().chain(dptree::filter(|| false))),
/// )
/// .branch(dptree::entry()),
/// );
/// ```
pub trait HandlerDescription: Sized + Send + Sync + 'static {
/// Description for [`entry`](crate::entry).
fn entry() -> Self;
/// Description for a user-defined handler that can do practically
/// everything.
fn user_defined() -> Self;
/// Merge descriptions to get a description for a chain handler.
fn merge_chain(&self, other: &Self) -> Self;
/// Merge descriptions to get a description for a branch handler.
fn merge_branch(&self, other: &Self) -> Self;
/// Description for [`map`](crate::map).
///
/// ## Default implementation
///
/// By default this returns the value from
/// [`user_defined`](HandlerDescription::user_defined).
#[track_caller]
fn map() -> Self {
Self::user_defined()
}
/// Description for [`map_async`](crate::map_async).
///
/// ## Default implementation
///
/// By default this returns the value from
/// [`user_defined`](HandlerDescription::user_defined).
#[track_caller]
fn map_async() -> Self {
Self::user_defined()
}
/// Description for [`filter`](crate::filter).
///
/// ## Default implementation
///
/// By default this returns the value from
/// [`user_defined`](HandlerDescription::user_defined).
#[track_caller]
fn filter() -> Self {
Self::user_defined()
}
/// Description for [`filter_async`](crate::filter_async).
///
/// ## Default implementation
///
/// By default this returns the value from
/// [`user_defined`](HandlerDescription::user_defined).
#[track_caller]
fn filter_async() -> Self {
Self::user_defined()
}
/// Description for [`filter_map`](crate::filter_map).
///
/// ## Default implementation
///
/// By default this returns the value from
/// [`user_defined`](HandlerDescription::user_defined).
#[track_caller]
fn filter_map() -> Self {
Self::user_defined()
}
/// Description for [`filter_map_async`](crate::filter_map_async).
///
/// ## Default implementation
///
/// By default this returns the value from
/// [`user_defined`](HandlerDescription::user_defined).
#[track_caller]
fn filter_map_async() -> Self {
Self::user_defined()
}
/// Description for [`inspect`](crate::inspect).
///
/// ## Default implementation
///
/// By default this returns the value from
/// [`user_defined`](HandlerDescription::user_defined).
#[track_caller]
fn inspect() -> Self {
Self::user_defined()
}
/// Description for [`inspect_async`](crate::inspect_async).
///
/// ## Default implementation
///
/// By default this returns the value from
/// [`user_defined`](HandlerDescription::user_defined).
#[track_caller]
fn inspect_async() -> Self {
Self::user_defined()
}
/// Description for [`endpoint`](crate::endpoint).
///
/// ## Default implementation
///
/// By default this returns the value from
/// [`user_defined`](HandlerDescription::user_defined).
#[track_caller]
fn endpoint() -> Self {
Self::user_defined()
}
}