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 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369
use crate::{fun::FunRef, ClosureRef, OneOf2};
/// `ClosureRefOneOf2<C1, C2, In, Out>` is a union of two closures:
///
/// * `ClosureRef<C1, In, Out>`
/// * `ClosureRef<C2, In, Out>`
///
/// This is useful when it is possible that the closure might capture and work with either of the two types of data `C1` and `C2`.
///
/// It represents the transformation `In -> &Out`.
///
/// Note that, unlike trait objects of fn-traits, `ClosureRefOneOf2` auto-implements `Clone` given that captured data variants are cloneable.
///
/// **Instead of `ClosureOneOf2`; this closure variant is particularly useful when we capture the data by value and return a reference.**
///
/// # Example
///
/// ```rust
/// use orx_closure::*;
///
/// type Toy = String;
/// struct Cat {
/// name: String,
/// favorite_toys: Vec<Toy>,
/// }
/// struct Dog {
/// name: String,
/// nickname: String,
/// favorite_toys: Vec<Toy>,
/// }
///
/// struct PresentIdeas<'a> {
/// // for cats or dogs
/// for_pet: ClosureRefOneOf2<Vec<Cat>, Vec<Dog>, &'a str, [Toy]>,
/// }
///
/// // cats
/// let cats = vec![Cat {
/// name: "bella".to_string(),
/// favorite_toys: vec!["ball".to_string()],
/// }];
/// let present_ideas = PresentIdeas {
/// for_pet: Capture(cats)
/// .fun_ref(|cats, name| {
/// cats.iter()
/// .find(|cat| cat.name == name)
/// .map(|cat| cat.favorite_toys.as_slice())
/// .unwrap_or(&[])
/// })
/// .into_oneof2_var1(),
/// };
///
/// assert_eq!(&["ball".to_string()], present_ideas.for_pet.call("bella"));
/// assert!(present_ideas.for_pet.call("luna").is_empty());
///
/// // dogs
/// let dogs = vec![Dog {
/// name: "luke".to_string(),
/// nickname: "dogzilla".to_string(),
/// favorite_toys: vec!["toy turtle".to_string()],
/// }];
/// let present_ideas = PresentIdeas {
/// for_pet: Capture(dogs)
/// .fun_ref(|dogs, name| {
/// dogs.iter()
/// .find(|dog| dog.name == name || dog.nickname == name)
/// .map(|dog| dog.favorite_toys.as_slice())
/// .unwrap_or(&[])
/// })
/// .into_oneof2_var2(),
/// };
/// assert_eq!(
/// &["toy turtle".to_string()],
/// present_ideas.for_pet.call("luke")
/// );
/// assert_eq!(
/// &["toy turtle".to_string()],
/// present_ideas.for_pet.call("dogzilla")
/// );
/// assert!(present_ideas.for_pet.call("tux").is_empty());
/// ```
#[derive(Clone, Debug)]
pub struct ClosureRefOneOf2<C1, C2, In, Out: ?Sized> {
closure: OneOf2<ClosureRef<C1, In, Out>, ClosureRef<C2, In, Out>>,
}
impl<C1, C2, In, Out: ?Sized> ClosureRefOneOf2<C1, C2, In, Out> {
/// Calls the closure with the given `input`.
///
/// # Example
///
/// ```rust
/// use orx_closure::*;
///
/// type Toy = String;
/// struct Cat {
/// name: String,
/// favorite_toys: Vec<Toy>,
/// }
/// struct Dog {
/// name: String,
/// nickname: String,
/// favorite_toys: Vec<Toy>,
/// }
///
/// struct PresentIdeas<'a> {
/// // for cats or dogs
/// for_pet: ClosureRefOneOf2<Vec<Cat>, Vec<Dog>, &'a str, [Toy]>,
/// }
///
/// // cats
/// let cats = vec![Cat {
/// name: "bella".to_string(),
/// favorite_toys: vec!["ball".to_string()],
/// }];
/// let present_ideas = PresentIdeas {
/// for_pet: Capture(cats)
/// .fun_ref(|cats, name| {
/// cats.iter()
/// .find(|cat| cat.name == name)
/// .map(|cat| cat.favorite_toys.as_slice())
/// .unwrap_or(&[])
/// })
/// .into_oneof2_var1(),
/// };
///
/// // calling the closure
/// assert_eq!(&["ball".to_string()], present_ideas.for_pet.call("bella"));
/// assert!(present_ideas.for_pet.call("luna").is_empty());
/// ```
#[inline(always)]
pub fn call(&self, input: In) -> &Out {
match &self.closure {
OneOf2::Variant1(fun) => fun.call(input),
OneOf2::Variant2(fun) => fun.call(input),
}
}
/// Returns a reference to the captured data.
#[inline(always)]
pub fn captured_data(&self) -> OneOf2<&C1, &C2> {
match &self.closure {
OneOf2::Variant1(x) => OneOf2::Variant1(x.captured_data()),
OneOf2::Variant2(x) => OneOf2::Variant2(x.captured_data()),
}
}
/// Consumes the closure and returns back the captured data.
///
/// # Examples
///
/// ```rust
/// use orx_closure::*;
///
/// type Toy = String;
/// #[derive(Debug, Clone, PartialEq, Eq)]
/// struct Cat {
/// name: String,
/// favorite_toys: Vec<Toy>,
/// }
/// #[derive(Debug, Clone, PartialEq, Eq)]
/// struct Dog {
/// name: String,
/// nickname: String,
/// favorite_toys: Vec<Toy>,
/// }
///
/// struct PresentIdeas<'a> {
/// // for cats or dogs
/// for_pet: ClosureRefOneOf2<Vec<Cat>, Vec<Dog>, &'a str, [Toy]>,
/// }
///
/// // cats
/// let cats = vec![Cat {
/// name: "bella".to_string(),
/// favorite_toys: vec!["ball".to_string()],
/// }];
/// let present_ideas = PresentIdeas {
/// for_pet: Capture(cats.clone()) // clone to use `cats` for validation later
/// .fun_ref(|cats, name| {
/// cats.iter()
/// .find(|cat| cat.name == name)
/// .map(|cat| cat.favorite_toys.as_slice())
/// .unwrap_or(&[])
/// })
/// .into_oneof2_var1(),
/// };
///
/// assert_eq!(&["ball".to_string()], present_ideas.for_pet.call("bella"));
/// assert!(present_ideas.for_pet.call("luna").is_empty());
///
/// // get back the captured data which can be one of the two options: cats or dogs:
///
/// let data = present_ideas.for_pet.into_captured_data();
///
/// assert_eq!(data, OneOf2::Variant1(cats));
/// ```
pub fn into_captured_data(self) -> OneOf2<C1, C2> {
match self.closure {
OneOf2::Variant1(fun) => OneOf2::Variant1(fun.into_captured_data()),
OneOf2::Variant2(fun) => OneOf2::Variant2(fun.into_captured_data()),
}
}
/// Returns the closure as an `impl Fn(In) -> &Out` struct, allowing the convenience
///
/// * to avoid the `call` method,
/// * or pass the closure to functions accepting a function generic over the `Fn`.
///
/// # Example
///
/// ```rust
/// use orx_closure::*;
///
/// type Toy = String;
/// struct Cat {
/// name: String,
/// favorite_toys: Vec<Toy>,
/// }
/// struct Dog;
///
/// struct PresentIdeas<'a> {
/// // for cats or dogs
/// for_pet: ClosureRefOneOf2<Vec<Cat>, Vec<Dog>, &'a str, [Toy]>,
/// }
///
/// // cats
/// let cats = vec![Cat {
/// name: "bella".to_string(),
/// favorite_toys: vec!["ball".to_string()],
/// }];
/// let present_ideas = PresentIdeas {
/// for_pet: Capture(cats)
/// .fun_ref(|cats, name| {
/// cats.iter()
/// .find(|cat| cat.name == name)
/// .map(|cat| cat.favorite_toys.as_slice())
/// .unwrap_or(&[])
/// })
/// .into_oneof2_var1(),
/// };
///
/// // function accepting an instance of the `Fn(&str) -> &[Toy]` trait
/// fn create_presents<'a, F: Fn(&'a str) -> &'a [Toy]>(present_ideas_for: F) -> Vec<Toy> {
/// ["bella", "luna"]
/// .iter()
/// .flat_map(|name| present_ideas_for(name).iter().cloned())
/// .collect()
/// }
///
/// // we can conveniently create the `Fn` with `as_fn`
/// let presents = create_presents(present_ideas.for_pet.as_fn());
/// assert_eq!(&["ball".to_string()], presents.as_slice());
/// ```
pub fn as_fn<'a>(&'a self) -> impl Fn(In) -> &'a Out {
move |x| self.call(x)
}
}
impl<Capture, In, Out: ?Sized> ClosureRef<Capture, In, Out> {
/// Transforms `ClosureRef<C1, In, Out>` into the more general `ClosureRefOneOf2<C1, C2, In, Out>` for any `C2`.
///
/// # Example
///
/// ```rust
/// use orx_closure::*;
///
/// type Toy = String;
/// struct Cat {
/// name: String,
/// favorite_toys: Vec<Toy>,
/// }
/// struct Dog {
/// name: String,
/// nickname: String,
/// favorite_toys: Vec<Toy>,
/// }
///
/// struct PresentIdeas<'a> {
/// // for cats or dogs
/// for_pet: ClosureRefOneOf2<Vec<Cat>, Vec<Dog>, &'a str, [Toy]>,
/// }
///
/// // cats
/// let cats = vec![Cat {
/// name: "bella".to_string(),
/// favorite_toys: vec!["ball".to_string()],
/// }];
/// let present_ideas = PresentIdeas {
/// for_pet: Capture(cats)
/// .fun_ref(|cats, name| {
/// cats.iter()
/// .find(|cat| cat.name == name)
/// .map(|cat| cat.favorite_toys.as_slice())
/// .unwrap_or(&[])
/// })
/// // transforms : ClosureRef<Vec<Cat>, &str, [Toy]>
/// // into more general : ClosureRefOneOf2<Vec<Cat>, Vec<Dog>, &str, [Toy]>
/// .into_oneof2_var1(),
/// };
///
/// assert_eq!(&["ball".to_string()], present_ideas.for_pet.call("bella"));
/// assert!(present_ideas.for_pet.call("luna").is_empty());
/// ```
pub fn into_oneof2_var1<Var2>(self) -> ClosureRefOneOf2<Capture, Var2, In, Out> {
let closure = OneOf2::Variant1(self);
ClosureRefOneOf2 { closure }
}
/// Transforms `ClosureRef<C2, In, Out>` into the more general `ClosureRefOneOf2<C1, C2, In, Out>` for any `C1`.
///
/// # Example
///
/// ```rust
/// use orx_closure::*;
///
/// type Toy = String;
/// struct Cat {
/// name: String,
/// favorite_toys: Vec<Toy>,
/// }
/// struct Dog {
/// name: String,
/// nickname: String,
/// favorite_toys: Vec<Toy>,
/// }
///
/// struct PresentIdeas<'a> {
/// // for cats or dogs
/// for_pet: ClosureRefOneOf2<Vec<Cat>, Vec<Dog>, &'a str, [Toy]>,
/// }
///
/// let dogs = vec![Dog {
/// name: "luke".to_string(),
/// nickname: "dogzilla".to_string(),
/// favorite_toys: vec!["toy turtle".to_string()],
/// }];
/// let present_ideas = PresentIdeas {
/// for_pet: Capture(dogs)
/// .fun_ref(|dogs, name| {
/// dogs.iter()
/// .find(|dog| dog.name == name || dog.nickname == name)
/// .map(|dog| dog.favorite_toys.as_slice())
/// .unwrap_or(&[])
/// })
/// // transforms : ClosureRef<Vec<Dog>, &str, [Toy]>
/// // into more general : ClosureRefOneOf2<Vec<Cat>, Vec<Dog>, &str, [Toy]>
/// .into_oneof2_var2(),
/// };
/// assert_eq!(
/// &["toy turtle".to_string()],
/// present_ideas.for_pet.call("luke")
/// );
/// assert_eq!(
/// &["toy turtle".to_string()],
/// present_ideas.for_pet.call("dogzilla")
/// );
/// assert!(present_ideas.for_pet.call("tux").is_empty());
/// ```
pub fn into_oneof2_var2<Var1>(self) -> ClosureRefOneOf2<Var1, Capture, In, Out> {
let closure = OneOf2::Variant2(self);
ClosureRefOneOf2 { closure }
}
}
impl<C1, C2, In, Out: ?Sized> FunRef<In, Out> for ClosureRefOneOf2<C1, C2, In, Out> {
fn call(&self, input: In) -> &Out {
ClosureRefOneOf2::call(self, input)
}
}