Packages

trait Signal[+A] extends Observable[A]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Signal
  2. Observable
  3. Named
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. type Self[+T] = Signal[T]

    Basic type for this observable.

    Basic type for this observable. Could be EventStream or Signal

    Definition Classes
    SignalObservable

Abstract Value Members

  1. abstract def initialValue: Try[A]

    Evaluate initial value of this Signal.

    Evaluate initial value of this Signal. This method must only be called once, when this value is first needed. You should override this method as def (no val or lazy val) to avoid holding a reference to the initial value beyond the duration of its relevance.

    Attributes
    protected[this]
  2. abstract val topoRank: Int

    When subclassing Observable **outside of com.raquo.airstream package**, just make this field public:

    When subclassing Observable **outside of com.raquo.airstream package**, just make this field public:

    override val topoRank: Int = ???

    "protected[airstream]" will allow this. See https://github.com/raquo/Airstream/issues/37

    Attributes
    protected[airstream]
    Definition Classes
    Observable

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def addInternalObserver(observer: InternalObserver[A]): Unit

    Child observable should call this method on its parents when it is started.

    Child observable should call this method on its parents when it is started. This observable calls onStart if this action has given it its first observer (internal or external).

    Attributes
    protected[airstream]
    Definition Classes
    Observable
  5. def addObserver(observer: Observer[A])(implicit owner: Owner): Subscription

    Subscribe an external observer to this observable

    Subscribe an external observer to this observable

    Definition Classes
    Observable
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. def changes: EventStream[A]
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  9. def compose[B](operator: (Signal[A]) => Signal[B]): Signal[B]

    operator

    Note: Must not throw!

  10. def composeAll[B](changesOperator: (EventStream[A]) => EventStream[B], initialOperator: (Try[A]) => Try[B]): Signal[B]

    changesOperator

    Note: Must not throw!

    initialOperator

    Note: Must not throw!

  11. def composeChanges[AA >: A](operator: (EventStream[A]) => EventStream[AA]): Signal[AA]

    operator

    Note: Must not throw!

  12. def debugWith(debugger: Debugger[A]): Signal[A]

    See also debug convenience method in Observable

    See also debug convenience method in Observable

    Definition Classes
    SignalObservable
  13. def defaultDisplayName: String

    This is the method that subclasses override to preserve the user's ability to set custom display names.

    This is the method that subclasses override to preserve the user's ability to set custom display names.

    Attributes
    protected
    Definition Classes
    Named
  14. final def displayName: String
    Definition Classes
    Named
  15. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  17. val externalObservers: ObserverList[Observer[A]]

    Note: Observer can be added more than once to an Observable.

    Note: Observer can be added more than once to an Observable. If so, it will observe each event as many times as it was added.

    Attributes
    protected[this]
    Definition Classes
    Observable
  18. final def fireError(nextError: Throwable, transaction: Transaction): Unit
    Attributes
    protected[this]
    Definition Classes
    SignalObservable
  19. def fireTry(nextValue: Try[A], transaction: Transaction): Unit

    Signal propagates only if its value has changed

    Signal propagates only if its value has changed

    Attributes
    protected[this]
    Definition Classes
    SignalObservable
  20. final def fireValue(nextValue: A, transaction: Transaction): Unit
    Attributes
    protected[this]
    Definition Classes
    SignalObservable
  21. def flatMap[B, Inner[_], Output[+_] <: Observable[_]](compose: (A) => Inner[B])(implicit strategy: FlattenStrategy[Self, Inner, Output]): Output[B]

    compose

    Note: guarded against exceptions

    Definition Classes
    Observable
    Annotations
    @inline()
  22. def foldLeft[B](makeInitial: (A) => B)(fn: (B, A) => B): Signal[B]

    makeInitial

    Note: guarded against exceptions

    fn

    Note: guarded against exceptions

  23. def foldLeftRecover[B](makeInitial: (Try[A]) => Try[B])(fn: (Try[B], Try[A]) => Try[B]): Signal[B]

    makeInitial

    currentParentValue => initialValue Note: must not throw

    fn

    (currentValue, nextParentValue) => nextValue

  24. def foreach(onNext: (A) => Unit)(implicit owner: Owner): Subscription

    Create an external observer from a function and subscribe it to this observable.

    Create an external observer from a function and subscribe it to this observable.

    Note: since you won't have a reference to the observer, you will need to call Subscription.kill() to unsubscribe

    Definition Classes
    Observable
  25. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  26. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  27. val internalObservers: ObserverList[InternalObserver[A]]

    Note: This is enforced to be a Set outside of the type system #performance

    Note: This is enforced to be a Set outside of the type system #performance

    Attributes
    protected[this]
    Definition Classes
    Observable
  28. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  29. def isStarted: Boolean
    Attributes
    protected[this]
    Definition Classes
    Observable
  30. def map[B](project: (A) => B): Signal[B]

    project

    Note: guarded against exceptions

    Definition Classes
    SignalObservable
  31. def mapTo[B](value: => B): Self[B]

    value is passed by name, so it will be evaluated whenever the Observable fires.

    value is passed by name, so it will be evaluated whenever the Observable fires. Use it to sample mutable values (e.g. myInput.ref.value in Laminar).

    See also: mapToStrict

    value

    Note: guarded against exceptions

    Definition Classes
    Observable
  32. def mapToStrict[B](value: B): Self[B]

    value is evaluated strictly, only once, when this method is called.

    value is evaluated strictly, only once, when this method is called.

    See also: mapTo

    Definition Classes
    Observable
  33. val maybeDisplayName: UndefOr[String]

    This name should identify the instance (observable or observer) uniquely enough for your purposes.

    This name should identify the instance (observable or observer) uniquely enough for your purposes. You can read / write it to simplify debugging. Airstream uses this in debugLog* methods. In the future, we will expand on this. #TODO[Debug] We don't use this to its full potential yet.

    Attributes
    protected[this]
    Definition Classes
    Named
  34. val maybeLastSeenCurrentValue: UndefOr[Try[A]]
    Attributes
    protected[this]
  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  38. def now(): A

    See comment for tryNow right above

    See comment for tryNow right above

    Attributes
    protected[airstream]
    Exceptions thrown

    Exception if current value is an error

  39. def observe(implicit owner: Owner): OwnedSignal[A]

    Add a noop observer to this signal to ensure that it's started.

    Add a noop observer to this signal to ensure that it's started. This lets you access .now and .tryNow on the resulting StrictSignal.

    You can use myStream.toWeakSignal.observe.tryNow() to read the last emitted value from event streams just as well.

  40. def onAddedExternalObserver(observer: Observer[A]): Unit
    Attributes
    protected
    Definition Classes
    SignalObservable
  41. def onStart(): Unit

    Here we need to ensure that Signal's default value has been evaluated.

    Here we need to ensure that Signal's default value has been evaluated. It is important because if a Signal gets started by means of its .changes stream acquiring an observer, nothing else would trigger this evaluation because initialValue is not directly used by the .changes stream. However, when the events start coming in, we will need this initialValue because Signal needs to know when its current value has changed.

    Attributes
    protected[this]
    Definition Classes
    SignalObservable
  42. def onStop(): Unit

    This method is fired when this observable stops working (listening for parent events and/or firing its own events), that is, when it loses its last Observer (internal or external).

    This method is fired when this observable stops working (listening for parent events and/or firing its own events), that is, when it loses its last Observer (internal or external).

    onStop can potentially be called multiple times, the second time being after it has started again (see onStart).

    Attributes
    protected[this]
    Definition Classes
    Observable
    Annotations
    @inline()
  43. def recover[B >: A](pf: PartialFunction[Throwable, Option[B]]): Signal[B]

    pf

    Note: guarded against exceptions

    Definition Classes
    SignalObservable
  44. def recoverIgnoreErrors: Self[A]
    Definition Classes
    Observable
  45. def recoverToTry: Signal[Try[A]]

    Convert this to an observable that emits Failure(err) instead of erroring

    Convert this to an observable that emits Failure(err) instead of erroring

    Definition Classes
    SignalObservable
  46. def removeExternalObserverNow(observer: Observer[A]): Unit
    Attributes
    protected[airstream]
    Definition Classes
    Observable
  47. def removeInternalObserverNow(observer: InternalObserver[A]): Unit

    Child observable should call Transaction.removeInternalObserver(parent, childInternalObserver) when it is stopped.

    Child observable should call Transaction.removeInternalObserver(parent, childInternalObserver) when it is stopped. This observable calls onStop if this action has removed its last observer (internal or external).

    Attributes
    protected[airstream]
    Definition Classes
    Observable
  48. def setCurrentValue(newValue: Try[A]): Unit
    Attributes
    protected[this]
  49. def setDisplayName(name: String): Signal.this.type

    Set the display name for this instance (observable or observer).

    Set the display name for this instance (observable or observer). - This method modifies the instance and returns this. It does not create a new instance. - New name you set will override the previous name, if any. This might change in the future. For the sake of sanity, don't call this more than once for the same instance. - If display name is set, toString will output it instead of the standard type@hashcode string

    Definition Classes
    Named
  50. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  51. def toSignal[AA >: A](initialIfStream: => AA): Signal[AA]
    Definition Classes
    Observable
  52. def toStreamOrSignalChanges: EventStream[A]
    Definition Classes
    Observable
  53. final def toString(): String

    Override defaultDisplayName instead of this, if you need to.

    Override defaultDisplayName instead of this, if you need to.

    Definition Classes
    Named → AnyRef → Any
  54. def tryNow(): Try[A]

    Initial value is only evaluated if/when needed (when there are observers)

    Initial value is only evaluated if/when needed (when there are observers)

    Attributes
    protected[airstream]
  55. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  56. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  57. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from Observable[A]

Inherited from Named

Inherited from AnyRef

Inherited from Any

Ungrouped