Packages

trait Event[+T] extends Operators.EventCompat[T] with Disconnectable

Events only propagate a value when they are changing, when the system is at rest, events have no values.

Note: We hide implicit parameters of the API in the documentation. They are used to ensure correct creation, and you normally do not have to worry about them, except if you accidentally call the implicit parameter list, in which cas you may get cryptic errors. This is a scala limitation. We also hide the internal state parameter of passed and returned events.

T

Value type of the event occurrences.

Linear Supertypes
Disconnectable, Operators.EventCompat[T], Operators.ReadableMacro[Operators.State, Option[T]], MacroAccess[Option[T], ReadAs[Operators.State, Option[T]]], ReadAs[Operators.State, Option[T]], ReSource, AnyRef, Any
Known Subclasses
ChangeEventImpl, EventImpl, Evt
Ordering
  1. Grouped
  2. Alphabetic
  3. By Inheritance
Inherited
  1. Event
  2. Disconnectable
  3. EventCompat
  4. ReadableMacro
  5. MacroAccess
  6. ReadAs
  7. ReSource
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final type State[V] = Operators.State[V]
    Definition Classes
    Event → ReadAs → ReSource
  2. abstract type Value
    Definition Classes
    ReSource

Abstract Value Members

  1. abstract def commit(base: Value): Value
    Attributes
    protected[rescala]
    Definition Classes
    ReSource
  2. abstract def disconnect(): Unit
    Definition Classes
    Disconnectable
  3. abstract def info: ReInfo
    Definition Classes
    ReSource
  4. implicit abstract def internalAccess(v: Value): Pulse[T]
  5. abstract def state: State[Value]
    Attributes
    protected[rescala]
    Definition Classes
    ReSource

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final macro def &&(expression: (T) ⇒ Boolean)(implicit ticket: CreationTicket): Operators.Event[T]

    Filters the event, only propagating the value when the filter is true.

    Filters the event, only propagating the value when the filter is true.

    Definition Classes
    EventCompat
    Annotations
    @cutOutOfUserComputation()
    See also

    filter

  4. final def +=(handler: (T) ⇒ Unit)(implicit ticket: CreationTicket): Disconnectable

    Adds an observer.

    Adds an observer.

    See also

    observe

  5. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  6. final def \[U](except: Operators.Event[U])(implicit ticket: CreationTicket): Operators.Event[T]

    Propagates the event only when except does not fire.

    Propagates the event only when except does not fire.

    Annotations
    @cutOutOfUserComputation()
  7. final def and[U, R](other: Operators.Event[U])(merger: (T, U) ⇒ R)(implicit ticket: CreationTicket): Operators.Event[R]

    Merge the event with the other, if both fire simultaneously.

    Merge the event with the other, if both fire simultaneously.

    Annotations
    @cutOutOfUserComputation()
  8. final def apply(): Option[T]

    Makes the enclosing reactive expression depend on the current value of the reactive.

    Makes the enclosing reactive expression depend on the current value of the reactive. Is an alias for value.

    Definition Classes
    MacroAccess
    Annotations
    @compileTimeOnly( ... )
    See also

    value

  9. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  10. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  11. final macro def collect[U](expression: PartialFunction[T, U])(implicit ticket: CreationTicket): Operators.Event[U]

    Collects the results from a partial function

    Collects the results from a partial function

    Definition Classes
    EventCompat
    Annotations
    @cutOutOfUserComputation()
  12. final def count()(implicit ticket: CreationTicket): Operators.Signal[Int]

    Counts the occurrences of the event.

    Counts the occurrences of the event. The argument of the event is discarded. Always starts from 0 when the count is created (no matter how often the event has activated in the past).

    Annotations
    @cutOutOfUserComputation()
  13. final def dropParam(implicit ticket: CreationTicket): Operators.Event[Unit]

    Drop the event parameter; equivalent to map((_: Any) => ())

    Drop the event parameter; equivalent to map((_: Any) => ())

    Annotations
    @cutOutOfUserComputation()
  14. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  15. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  16. final macro def filter(expression: (T) ⇒ Boolean)(implicit ticket: CreationTicket): Operators.Event[T]

    Filters the event, only propagating the value when the filter is true.

    Filters the event, only propagating the value when the filter is true.

    Definition Classes
    EventCompat
    Annotations
    @cutOutOfUserComputation()
  17. final def flatten[R](implicit flatten: Operators.Flatten[Operators.Event[T], R]): R

    Flattens the inner value.

    Flattens the inner value.

    Annotations
    @cutOutOfUserComputation()
  18. final macro def fold[A](init: A)(op: (A, T) ⇒ A)(implicit ticket: CreationTicket): Operators.Signal[A]

    Folds events with a given operation to create a Signal.

    Folds events with a given operation to create a Signal.

    Definition Classes
    EventCompat
    Annotations
    @cutOutOfUserComputation()
  19. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  20. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  21. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  22. final def iterate[A](init: A)(f: (A) ⇒ A)(implicit ticket: CreationTicket): Operators.Signal[A]

    Applies a function on the current value of the signal every time the event occurs, starting with the init value before the first event occurrence

    Applies a function on the current value of the signal every time the event occurs, starting with the init value before the first event occurrence

    Annotations
    @cutOutOfUserComputation()
  23. final def last[A >: T](n: Int)(implicit ticket: CreationTicket): Operators.Signal[LinearSeq[A]]

    Returns a signal which holds the last n events in a list.

    Returns a signal which holds the last n events in a list. At the beginning the list increases in size up to when n values are available

    Annotations
    @cutOutOfUserComputation()
  24. final def latest[A >: T]()(implicit ticket: CreationTicket): Operators.Signal[A]

    returns a signal holding the latest value of the event.

    returns a signal holding the latest value of the event.

    Annotations
    @cutOutOfUserComputation()
  25. final def latest[A >: T](init: A)(implicit ticket: CreationTicket): Operators.Signal[A]

    returns a signal holding the latest value of the event.

    returns a signal holding the latest value of the event.

    init

    initial value of the returned signal

    Annotations
    @cutOutOfUserComputation()
  26. final def latestOption[A >: T]()(implicit ticket: CreationTicket): Operators.Signal[Option[A]]

    Holds the latest value of an event as an Option, None before the first event occured

    Holds the latest value of an event as an Option, None before the first event occured

    Annotations
    @cutOutOfUserComputation()
  27. final def list[A >: T]()(implicit ticket: CreationTicket): Operators.Signal[List[A]]

    collects events resulting in a variable holding a list of all values.

    collects events resulting in a variable holding a list of all values.

    Annotations
    @cutOutOfUserComputation()
  28. final macro def map[A](expression: (T) ⇒ A)(implicit ticket: CreationTicket): Operators.Event[A]

    Transform the event.

    Transform the event.

    Definition Classes
    EventCompat
    Annotations
    @cutOutOfUserComputation()
  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  32. final def observe(onValue: (T) ⇒ Unit, onError: (Throwable) ⇒ Unit = null, fireImmediately: Boolean = false)(implicit ticket: CreationTicket): Disconnectable

    Add an observer.

    Add an observer.

    returns

    the resulting rescala.operator.ObserveBundle.Observe can be used to remove the observer.

  33. def read(v: Value): Option[T]

    Interprets the pulse of the event by converting to an option

    Interprets the pulse of the event by converting to an option

    Definition Classes
    Event → ReadAs
  34. final def recover[R >: T](onFailure: PartialFunction[Throwable, Option[R]])(implicit ticket: CreationTicket): Operators.Event[R]

    Uses a partial function onFailure to recover an error carried by the event into a value when returning Some(value), or filters the error when returning None

  35. final def reduce[A](reducer: (⇒ A, ⇒ T) ⇒ A)(implicit ticket: CreationTicket): Operators.Signal[A]

    reduces events with a given reduce function to create a Signal

    reduces events with a given reduce function to create a Signal

    Annotations
    @cutOutOfUserComputation()
  36. def resource: of[State, Option[T]]
    Definition Classes
    Event → MacroAccess
  37. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  38. def toString(): String
    Definition Classes
    AnyRef → Any
  39. final def toggle[A](a: Operators.Signal[A], b: Operators.Signal[A])(implicit ticket: CreationTicket): Operators.Signal[A]

    Switch back and forth between two signals on occurrence of event e

    Switch back and forth between two signals on occurrence of event e

    Annotations
    @cutOutOfUserComputation()
  40. final def value: Option[T]

    Makes the enclosing reactive expression depend on the current value of the reactive.

    Makes the enclosing reactive expression depend on the current value of the reactive. Is an alias for rescala.macros.MacroAccess.apply.

    Definition Classes
    MacroAccess
    Annotations
    @compileTimeOnly( ... )
    See also

    apply

  41. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  42. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  43. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  44. final def zip[U](other: Operators.Event[U])(implicit ticket: CreationTicket): Operators.Event[(T, U)]

    Merge the event with the other into a tuple, if both fire simultaneously.

    Merge the event with the other into a tuple, if both fire simultaneously.

    Annotations
    @cutOutOfUserComputation()
    See also

    and

  45. final def zipOuter[U](other: Operators.Event[U])(implicit ticket: CreationTicket): Operators.Event[(Option[T], Option[U])]

    Merge the event with the other into a tuple, even if only one of them fired.

    Merge the event with the other into a tuple, even if only one of them fired.

    Annotations
    @cutOutOfUserComputation()
  46. final def ||[U >: T](other: Operators.Event[U])(implicit ticket: CreationTicket): Operators.Event[U]

    Events disjunction.

    Events disjunction. Propagates the values if any of the events fires. Only propagates the left event if both fire.

    Annotations
    @cutOutOfUserComputation()

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Disconnectable

Inherited from Operators.EventCompat[T]

Inherited from Operators.ReadableMacro[Operators.State, Option[T]]

Inherited from MacroAccess[Option[T], ReadAs[Operators.State, Option[T]]]

Inherited from ReadAs[Operators.State, Option[T]]

Inherited from ReSource

Inherited from AnyRef

Inherited from Any

internal

Accessor and observers

Event operators

Event to Signal conversions

Ungrouped