Module pasts::notify

Asynchronous event notifys

A Notify is kind of like a cross between a Future and an AsyncIterator. Like streams, they may return more than one value, and are expected to not panic after polling. Like futures, they produce non-optional values. In a sense they are an infinite stream. In another sense, they are a repeating future.

Why Another Abstraction?

Notifys allow for some nice ergonomics and guarantees when working with event-loop based asynchronous code, which could lead to some simplifications. Unlike futures and streams, they do not need to be fused, and if your stream is infinite, you won’t need to sprinkle unwrap()s in your code at each call to .next(). They also lend themselves nicely for creating clean and simple multimedia APIs.

Structs

• FutureFn
  A Notify that wraps a function returning a Future
• Map
  The Notify returned from NotifyExt::map()
• Next
  The Future returned from NotifyExt::next()
• Pending
  A Notify that never produces an event.
• PollFn
  A Notify created from a function returning Poll
• Ready
  A Notify that immediately produces a single event.
• Select
  A Notify that selects over a list of Notifys

Traits

• Fuse
  Trait for “fusing” a Future (conversion to a Notify)
• Notify
  Trait for asynchronous event notification
• NotifyExt
  An extension trait for Notifys that provides a variety of convenient adapters.

Functions

• future_fn
  Create a Notify that wraps a function returning a Future.
• pending
  Create a Notify which never becomes ready with an event.
• poll_fn
  Create a Notify that wraps a function returning Poll.
• ready
  Create a Notify which is immediately ready with an event.
• select
  Create a Notify that selects over a list of Notifys.

Type Definitions

• BoxNotify
  An owned dynamically typed Notify for use in cases where you can’t statically type your result or need to add some indirection.
• LocalBoxNotify
  BoxNotify without the Send requirement.