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 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492
//! Custom `Future` implementation with `Actix` support use futures::{Future, Poll, Stream}; use std::marker::PhantomData; use std::time::Duration; mod and_then; mod chain; mod either; mod from_err; mod helpers; mod map; mod map_err; mod result; mod stream_and_then; mod stream_finish; mod stream_fold; mod stream_map; mod stream_map_err; mod stream_then; mod stream_timeout; mod then; mod timeout; pub use self::and_then::AndThen; pub use self::either::Either; pub use self::from_err::FromErr; pub use self::helpers::{Finish, FinishStream}; pub use self::map::Map; pub use self::map_err::{DropErr, MapErr}; pub use self::result::{err, ok, result, FutureResult}; pub use self::stream_and_then::StreamAndThen; pub use self::stream_finish::StreamFinish; pub use self::stream_fold::StreamFold; pub use self::stream_map::StreamMap; pub use self::stream_map_err::StreamMapErr; pub use self::stream_then::StreamThen; pub use self::stream_timeout::StreamTimeout; pub use self::then::Then; pub use self::timeout::Timeout; use crate::actor::Actor; /// Trait for types which are a placeholder of a value that may become /// available at some later point in time. /// /// `ActorFuture` is very similar to a regular `Future`, only with subsequent combinator closures accepting the actor and its context, in addition to the result. /// /// `ActorFuture` allows for use cases where future processing requires access to the actor or its context. /// /// Here is an example of a handler on a single actor, deferring work to another actor, and /// then updating the initiating actor's state: /// /// ```rust,ignore /// impl Message for SomeMessage { /// type Result = (); /// } /// /// impl Handler<DeferredWork> for OriginalActor { /// // Notice the `Response` is an `ActorFuture`-ized version of `Self::Message::Result`. /// type Result = ResponseActFuture<Self, (), Error>; /// /// fn handle(&mut self, _msg: Refresh, ctx: &mut Context<Self>) -> Self::Result { /// // this creates a `Future` representing the `.send` and subsequent `Result` from /// // `other_actor` /// let send_to_other = self.other_actor_addr /// .send(OtherMessage::new()) /// .map_err(Error::from); /// /// // Wrap that `Future` so subsequent chained handlers can access /// // the `actor` (`self` in the synchronous code) as well as the context. /// let send_to_other = actix::fut::wrap_future::<_, Self>(send_to_other); /// /// // once the wrapped future resolves, update this actor's state /// let update_self = send_to_other.map(|result, actor, _ctx| { /// // Actor's state updated here /// actor.inner_state.update_from(result); /// }); /// /// // return the wrapped future /// Box::new(update_self) /// } /// } /// ``` /// /// See also [into_actor](trait.WrapFuture.html#tymethod.into_actor), which provides future conversion using trait pub trait ActorFuture { /// The type of value that this future will resolved with if it is /// successful. type Item; /// The type of error that this future will resolve with if it fails in a /// normal fashion. type Error; /// The actor within which this future runs type Actor: Actor; fn poll( &mut self, srv: &mut Self::Actor, ctx: &mut <Self::Actor as Actor>::Context, ) -> Poll<Self::Item, Self::Error>; /// Map this future's result to a different type, returning a new future of /// the resulting type. fn map<F, U>(self, f: F) -> Map<Self, F> where F: FnOnce( Self::Item, &mut Self::Actor, &mut <Self::Actor as Actor>::Context, ) -> U, Self: Sized, { map::new(self, f) } /// Map this future's error to a different error, returning a new future. fn map_err<F, E>(self, f: F) -> MapErr<Self, F> where F: FnOnce( Self::Error, &mut Self::Actor, &mut <Self::Actor as Actor>::Context, ) -> E, Self: Sized, { map_err::new(self, f) } /// Drop this future's error, returning a new future. fn drop_err(self) -> DropErr<Self> where Self: Sized, { map_err::DropErr::new(self) } /// Map this future's error to any error implementing `From` for /// this future's `Error`, returning a new future. fn from_err<E: From<Self::Error>>(self) -> FromErr<Self, E> where Self: Sized, { from_err::new(self) } /// Chain on a computation for when a future finished, passing the result of /// the future to the provided closure `f`. fn then<F, B>(self, f: F) -> Then<Self, B, F> where F: FnOnce( Result<Self::Item, Self::Error>, &mut Self::Actor, &mut <Self::Actor as Actor>::Context, ) -> B, B: IntoActorFuture<Actor = Self::Actor>, Self: Sized, { then::new(self, f) } /// Execute another future after this one has resolved successfully. fn and_then<F, B>(self, f: F) -> AndThen<Self, B, F> where F: FnOnce( Self::Item, &mut Self::Actor, &mut <Self::Actor as Actor>::Context, ) -> B, B: IntoActorFuture<Error = Self::Error, Actor = Self::Actor>, Self: Sized, { and_then::new(self, f) } /// Add timeout to futures chain. /// /// `err` value get returned as a timeout error. fn timeout(self, timeout: Duration, err: Self::Error) -> Timeout<Self> where Self: Sized, { timeout::new(self, timeout, err) } } /// A stream of values, not all of which may have been produced yet. /// /// This is similar to `futures::Stream` trait, except it works with `Actor` pub trait ActorStream { /// The type of item this stream will yield on success. type Item; /// The type of error this stream may generate. type Error; /// The actor within which this stream runs. type Actor: Actor; fn poll( &mut self, srv: &mut Self::Actor, ctx: &mut <Self::Actor as Actor>::Context, ) -> Poll<Option<Self::Item>, Self::Error>; /// Converts a stream of type `T` to a stream of type `U`. fn map<U, F>(self, f: F) -> StreamMap<Self, F> where F: FnMut( Self::Item, &mut Self::Actor, &mut <Self::Actor as Actor>::Context, ) -> U, Self: Sized, { stream_map::new(self, f) } /// Converts a stream of error type `T` to a stream of error type `E`. fn map_err<E, F>(self, f: F) -> StreamMapErr<Self, F> where F: FnMut( Self::Error, &mut Self::Actor, &mut <Self::Actor as Actor>::Context, ) -> E, Self: Sized, { stream_map_err::new(self, f) } /// Chain on a computation for when a value is ready, passing the resulting /// item to the provided closure `f`. fn then<F, U>(self, f: F) -> StreamThen<Self, F, U> where F: FnMut( Result<Self::Item, Self::Error>, &mut Self::Actor, &mut <Self::Actor as Actor>::Context, ) -> U, U: IntoActorFuture<Actor = Self::Actor>, Self: Sized, { stream_then::new(self, f) } /// Chain on a computation for when a value is ready, passing the successful /// results to the provided closure `f`. fn and_then<F, U>(self, f: F) -> StreamAndThen<Self, F, U> where F: FnMut( Self::Item, &mut Self::Actor, &mut <Self::Actor as Actor>::Context, ) -> U, U: IntoActorFuture<Error = Self::Error, Actor = Self::Actor>, Self: Sized, { stream_and_then::new(self, f) } /// Execute an accumulating computation over a stream, collecting all the /// values into one final result. fn fold<F, T, Fut>(self, init: T, f: F) -> StreamFold<Self, F, Fut, T> where F: FnMut( T, Self::Item, &mut Self::Actor, &mut <Self::Actor as Actor>::Context, ) -> Fut, Fut: IntoActorFuture<Actor = Self::Actor, Item = T>, Self::Error: From<Fut::Error>, Self: Sized, { stream_fold::new(self, f, init) } /// Add timeout to stream. /// /// `err` value get returned as a timeout error. fn timeout(self, timeout: Duration, err: Self::Error) -> StreamTimeout<Self> where Self: Sized, Self::Error: Clone, { stream_timeout::new(self, timeout, err) } /// Converts a stream to a future that resolves when stream finishes. fn finish(self) -> StreamFinish<Self> where Self: Sized, { stream_finish::new(self) } } /// Class of types which can be converted into an actor future. /// /// This trait is very similar to the `IntoIterator` trait and is intended to be /// used in a very similar fashion. pub trait IntoActorFuture { /// The future that this type can be converted into. #[cfg_attr(rustfmt, rustfmt_skip)] type Future: ActorFuture<Item=Self::Item, Error=Self::Error, Actor=Self::Actor>; /// The item that the future may resolve with. type Item; /// The error that the future may resolve with. type Error; /// The actor within which this future runs type Actor: Actor; /// Consumes this object and produces a future. fn into_future(self) -> Self::Future; } impl<F: ActorFuture> IntoActorFuture for F { type Future = F; type Item = F::Item; type Error = F::Error; type Actor = F::Actor; fn into_future(self) -> F { self } } impl<F: ActorFuture + ?Sized> ActorFuture for Box<F> { type Item = F::Item; type Error = F::Error; type Actor = F::Actor; fn poll( &mut self, srv: &mut Self::Actor, ctx: &mut <Self::Actor as Actor>::Context, ) -> Poll<Self::Item, Self::Error> { (**self).poll(srv, ctx) } } /// Helper trait that allows conversion of normal future into `ActorFuture` pub trait WrapFuture<A> where A: Actor, { /// The future that this type can be converted into. type Future: ActorFuture<Item = Self::Item, Error = Self::Error, Actor = A>; /// The item that the future may resolve with. type Item; /// The error that the future may resolve with. type Error; #[doc(hidden)] fn actfuture(self) -> Self::Future; /// Convert normal future to a ActorFuture fn into_actor(self, a: &A) -> Self::Future; } impl<F: Future, A: Actor> WrapFuture<A> for F { type Future = FutureWrap<F, A>; type Item = F::Item; type Error = F::Error; #[doc(hidden)] fn actfuture(self) -> Self::Future { wrap_future(self) } fn into_actor(self, _: &A) -> Self::Future { wrap_future(self) } } pub struct FutureWrap<F, A> where F: Future, { fut: F, act: PhantomData<A>, } /// Converts normal future into `ActorFuture`, allowing its processing to /// use the actor's state. /// /// See the documentation for [ActorFuture](trait.ActorFuture.html) for a practical example involving both /// `wrap_future` and `ActorFuture` pub fn wrap_future<F, A>(f: F) -> FutureWrap<F, A> where F: Future, { FutureWrap { fut: f, act: PhantomData, } } impl<F, A> ActorFuture for FutureWrap<F, A> where F: Future, A: Actor, { type Item = F::Item; type Error = F::Error; type Actor = A; fn poll( &mut self, _: &mut Self::Actor, _: &mut <Self::Actor as Actor>::Context, ) -> Poll<Self::Item, Self::Error> { self.fut.poll() } } /// Helper trait that allows conversion of normal stream into `ActorStream` pub trait WrapStream<A> where A: Actor, { /// The stream that this type can be converted into. type Stream: ActorStream<Item = Self::Item, Error = Self::Error, Actor = A>; /// The item that the future may resolve with. type Item; /// The error that the future may resolve with. type Error; #[doc(hidden)] fn actstream(self) -> Self::Stream; /// Convert normal stream to a ActorStream fn into_actor(self, a: &A) -> Self::Stream; } impl<S: Stream, A: Actor> WrapStream<A> for S { type Stream = StreamWrap<S, A>; type Item = S::Item; type Error = S::Error; #[doc(hidden)] fn actstream(self) -> Self::Stream { wrap_stream(self) } fn into_actor(self, _: &A) -> Self::Stream { wrap_stream(self) } } pub struct StreamWrap<S, A> where S: Stream, { st: S, act: PhantomData<A>, } /// Converts normal stream into `ActorStream` pub fn wrap_stream<S, A>(s: S) -> StreamWrap<S, A> where S: Stream, { StreamWrap { st: s, act: PhantomData, } } impl<S, A> ActorStream for StreamWrap<S, A> where S: Stream, A: Actor, { type Item = S::Item; type Error = S::Error; type Actor = A; fn poll( &mut self, _: &mut Self::Actor, _: &mut <Self::Actor as Actor>::Context, ) -> Poll<Option<Self::Item>, Self::Error> { self.st.poll() } }