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 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250
use crate::dom::Modifier;
use crate::dom::Task;
use std::future::ready;
use std::future::Future;
/// Effects is a convenient way to group Msg for component to execute subsequent updates based on certain conditions.
/// This can be used for doing animation and incremental changes to the view to provide an effect
/// of transition or animation.
///
/// Effects contains 2 types of Messages. The local messages which will be executed in its
/// own component on the next update loop. The other type is the external effects which are Messages
/// that are sent to the parent Component in response to an event that has been triggerred.
pub struct Effects<MSG, XMSG> {
/// Messages that will be executed locally in the Component
pub local: Vec<Task<MSG>>,
/// effects that will be executed on the parent Component which instantiate
/// this component
pub external: Vec<Task<XMSG>>,
pub(crate) modifier: Modifier,
}
impl<MSG, XMSG> Effects<MSG, XMSG>
where
MSG: 'static,
{
/// create a new Effects with local and external expects respectively
pub fn new(
local: impl IntoIterator<Item = MSG>,
external: impl IntoIterator<Item = XMSG>,
) -> Self
where
XMSG: 'static,
{
Self {
local: local.into_iter().map(|l| Task::new(ready(l))).collect(),
external: external.into_iter().map(|x| Task::new(ready(x))).collect(),
modifier: Modifier::default(),
}
}
/// Create a new Effects with local and external futures that can resolve to MSG and XMSG
/// respectively
pub fn with_async<F, FX>(
local: impl IntoIterator<Item = F>,
external: impl IntoIterator<Item = FX>,
) -> Self
where
F: Future<Output = MSG> + 'static,
FX: Future<Output = XMSG> + 'static,
XMSG: 'static,
{
Self {
local: local.into_iter().map(Task::from).collect(),
external: external.into_iter().map(Task::from).collect(),
modifier: Modifier::default(),
}
}
/// Create an Effects with local messages that will be executed on the next update loop on this Component
pub fn with_local(local: impl IntoIterator<Item = MSG>) -> Self {
Self {
local: local.into_iter().map(|l| Task::new(ready(l))).collect(),
external: vec![],
modifier: Modifier::default(),
}
}
/// Create an Effects with local message that will can resolved into MSG, it will be executed
/// on the next update loop on the component it is being returned
pub fn with_local_async<F>(local: impl IntoIterator<Item = F>) -> Self
where
F: Future<Output = MSG> + 'static,
{
Self {
local: local.into_iter().map(Task::from).collect(),
external: vec![],
modifier: Modifier::default(),
}
}
/// Create an Effects with extern messages that will be executed on the parent Component
pub fn with_external(external: impl IntoIterator<Item = XMSG>) -> Self
where
XMSG: 'static,
{
Self {
local: vec![],
external: external.into_iter().map(|x| Task::new(ready(x))).collect(),
modifier: Modifier::default(),
}
}
/// Create an Effects with external messages that will can be resolved into an XMSG, this will
/// be dispatch in the next Component update
pub fn with_external_async<F>(external: impl IntoIterator<Item = F>) -> Self
where
F: Future<Output = XMSG> + 'static,
XMSG: 'static,
{
Self {
local: vec![],
external: external.into_iter().map(Task::from).collect(),
modifier: Modifier::default(),
}
}
/// Create and empty Effects
pub fn none() -> Self {
Self {
local: vec![],
external: vec![],
modifier: Modifier::default(),
}
}
/// Map the local messages of this Effects such that MSG will be transposed into
/// MSG2 with the use of the mapping function `f`.
///
/// The external messages stays the same.
pub fn map_msg<F, MSG2>(self, f: F) -> Effects<MSG2, XMSG>
where
F: Fn(MSG) -> MSG2 + Clone + 'static,
MSG2: 'static,
{
let Effects {
local,
external,
modifier,
} = self;
Effects {
local: local.into_iter().map(|l| l.map_msg(f.clone())).collect(),
external,
modifier,
}
}
/// Map the external messages of this Effects such that XMSG will be transposed into XMSG2
/// with the use of the mapping function `f`
pub fn map_external<F, XMSG2>(self, f: F) -> Effects<MSG, XMSG2>
where
F: Fn(XMSG) -> XMSG2 + Clone + 'static,
XMSG: 'static,
XMSG2: 'static,
{
let Effects {
local,
external,
modifier,
} = self;
Effects {
local,
external: external.into_iter().map(|l| l.map_msg(f.clone())).collect(),
modifier,
}
}
/// derives an Effects which contains only local effects by transforming the external messages
/// and mapping them with function `f` such that they can be of the same type as local effects
/// them merge them together into local effects.
///
pub fn localize<F, XMSG2>(self, f: F) -> Effects<XMSG, XMSG2>
where
F: Fn(MSG) -> XMSG + Clone + 'static,
XMSG: 'static,
XMSG2: 'static,
{
let Effects {
local,
external,
modifier,
} = self;
Effects {
local: external
.into_iter()
.chain(local.into_iter().map(|x| x.map_msg(f.clone())))
.collect(),
external: vec![],
modifier,
}
}
/// Append this msgs to the local effects
pub fn append_local(mut self, local: impl IntoIterator<Item = MSG>) -> Self {
self.local
.extend(local.into_iter().map(|l| Task::new(ready(l))));
self
}
/// Modify the Effect such that it will not do an update on the view when it is executed
pub fn no_render(mut self) -> Self {
self.modifier.should_update_view = false;
self
}
/// Modify the Effect such that it will log measurement when it is executed
pub fn measure(mut self) -> Self {
self.modifier.log_measurements = true;
self
}
/// Modify the Effect such that it will log measurement tag with the name supplied
pub fn measure_with_name(mut self, name: &str) -> Self {
self.modifier.measurement_name = name.to_string();
self.measure()
}
/// Merge all the internal objects of this Vec of Effects to produce only one.
pub fn batch(all_effects: impl IntoIterator<Item = Self>) -> Self {
let mut local = vec![];
let mut external = vec![];
let mut modifier = Modifier::default();
for effect in all_effects {
local.extend(effect.local);
external.extend(effect.external);
modifier.coalesce(&effect.modifier);
}
Effects {
local,
external,
modifier,
}
}
/// Extern the local and external MSG of this Effect
pub fn extend(
mut self,
local: impl IntoIterator<Item = MSG>,
external: impl IntoIterator<Item = XMSG>,
) -> Self
where
XMSG: 'static,
{
self.local
.extend(local.into_iter().map(|l| Task::new(ready(l))));
self.external
.extend(external.into_iter().map(|x| Task::new(ready(x))));
self
}
}
impl<MSG, XMSG> From<Task<MSG>> for Effects<MSG, XMSG> {
fn from(task: Task<MSG>) -> Effects<MSG, XMSG> {
Effects {
local: vec![task],
external: vec![],
modifier: Modifier::default(),
}
}
}