Airstream
API
Generated with
Airstream/com.raquo.airstream/com.raquo.airstream.debug

com.raquo.airstream.debug

package com.raquo.airstream.debug

Members list

Type members

Classlikes

class DebuggableObservable[Self <: (Observable), +A](val observable: BaseObservable[Self, A])

This implicit class provides debug* methods for observables, e.g.:

This implicit class provides debug* methods for observables, e.g.:

stream.debugWithName("MyStream").debugSpyStarts().debugLogEvents()

The result of the chain is an observable that you should use in place of the original observable (stream in this case).

The implicit conversion to this class is defined in the Observable companion object.

This is not a value class because DebuggableSignal needs to extend this. The performance penalty of one extra instantiation per debugged stream should not be noticeable.

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
class DebuggableSignal[A]
class DebuggableStream[A]
final class DebuggableObserver[A](val observer: Observer[A]) extends AnyVal

This implicit class provides debug* methods for observers.

This implicit class provides debug* methods for observers.

Every debug* method creates a new observer that performs the specified behaviour and then calls the original observer.

Note: type inference doesn't work on Observer debug* methods, so you need to provide the AA type param (it should be same as A).

Attributes

Supertypes
class AnyVal
trait Matchable
class Any
class DebuggableSignal[+A](val observable: Signal[A]) extends DebuggableObservable[Signal, A]

This implicit class provides Signal-specific debug* methods, e.g.:

This implicit class provides Signal-specific debug* methods, e.g.:

signal.debugLogInitialEval().debugLog()

See DebuggableObservable and the docs for details.

The implicit conversion to this class is defined in the Signal companion object.

This is not a value class because it needs to extend DebuggableObservable. The performance penalty of one extra instantiation per debugged stream should not be noticeable.

Attributes

Supertypes
class Object
trait Matchable
class Any
class DebuggableStream[+A](val observable: EventStream[A]) extends DebuggableObservable[EventStream, A]

This class exists for type inference purposes only (see "observable debugger type inference" test in DebugSpec), the real meat is in DebuggableObservable.

This class exists for type inference purposes only (see "observable debugger type inference" test in DebugSpec), the real meat is in DebuggableObservable.

Attributes

Supertypes
class Object
trait Matchable
class Any
case class Debugger[-A](onStart: () => Unit, onStop: () => Unit, onFire: Try[A] => Unit, onEvalFromParent: Try[A] => Unit)

Debugger for observables

Debugger for observables

Value parameters

onEvalFromParent

Only for signals. Fired when signal calls currentValueFromParent, which happens 1) when the signal is first started and its initial value is evaluated, AND 2) also when the signal is re-started after being stopped, when that method is called to re-sync this signal's value with the parent. #TODO[Integrity]: I'm not 100% sure if this hook reports correctly. - It actually reports the debugger signal's own calls to currentValueFromParent and I'm not 100% sure that they match with the parent's calls. I think they should match, at least if parent signal is always used via its debug signal, but to be honest I'm not really sure.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
trait DebuggerObservable[A] extends InternalTryObserver[A]

See DebuggableObservable and DebuggableSignal for user-facing debug methods

See DebuggableObservable and DebuggableSignal for user-facing debug methods

Attributes

Companion
object
Supertypes
trait InternalObserver[A]
class Object
trait Matchable
class Any
Known subtypes
class DebuggerSignal[A]
class DebuggerStream[A]
object DebuggerObservable

Attributes

Companion
trait
Supertypes
class Object
trait Matchable
class Any
Self type
class DebuggerObserver[A](parent: Observer[A], debug: Try[A] => Unit) extends Observer[A]

See DebuggableObserver for user-facing debug methods

See DebuggableObserver for user-facing debug methods

Attributes

Supertypes
trait Observer[A]
trait Named
trait Sink[A]
class Object
trait Matchable
class Any
Show all
class DebuggerSignal[A](val parent: Signal[A], val debugger: Debugger[A]) extends SingleParentSignal[A, A], DebuggerObservable[A]

See DebuggableObservable and DebuggableSignal for user-facing debug methods

See DebuggableObservable and DebuggableSignal for user-facing debug methods

Attributes

Supertypes
trait SingleParentSignal[A, A]
trait InternalObserver[A]
trait WritableSignal[A]
trait Signal[A]
trait SignalSource[A]
trait Observable[A]
trait Named
trait Source[A]
class Object
trait Matchable
class Any
Show all
class DebuggerStream[A](val parent: EventStream[A], val debugger: Debugger[A]) extends SingleParentStream[A, A], DebuggerObservable[A]

See DebuggableObservable and DebuggableSignal for user-facing debug methods

See DebuggableObservable and DebuggableSignal for user-facing debug methods

Attributes

Supertypes
trait SingleParentStream[A, A]
trait InternalObserver[A]
trait WritableStream[A]
trait EventStream[A]
trait EventSource[A]
trait Observable[A]
trait Named
trait Source[A]
class Object
trait Matchable
class Any
Show all
Generated with