CustomStreamSource

class CustomStreamSource[A](makeConfig: (() => A, FireError, GetStartIndex, GetIsStarted) => Config) extends WritableStream[A] with CustomSource[A]

Use this to easily create a custom signal from an external source

See docs on custom sources, and CustomSource.Config

Companion:
object
trait CustomSource[A]
trait EventStream[A]
trait EventSource[A]
trait Observable[A]
trait Named
trait Source[A]
class Object
trait Matchable
class Any

Value members

Inherited methods

override 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
Inherited from:
WritableObservable
def collect[B](pf: PartialFunction[A, B]): EventStream[B]

Apply pf to event and emit the resulting value, or emit nothing if pf is not defined for that event.

Apply pf to event and emit the resulting value, or emit nothing if pf is not defined for that event.

Value parameters:
pf

Note: guarded against exceptions

Inherited from:
EventStream
def collectOpt[B](fn: A => Option[B]): EventStream[B]

Apply fn to parent stream event, and emit resulting x if it returns Some(x)

Apply fn to parent stream event, and emit resulting x if it returns Some(x)

Value parameters:
fn

Note: guarded against exceptions

Inherited from:
EventStream
def collectSome[B](implicit ev: A <:< Option[B]): EventStream[B]

Emit x if parent stream emits Some(x), nothing otherwise

Emit x if parent stream emits Some(x), nothing otherwise

Inherited from:
EventStream
def compose[B](operator: EventStream[A] => EventStream[B]): EventStream[B]
Inherited from:
EventStream
def debounce(ms: Int): EventStream[A]

See docs for DebounceStream

See docs for DebounceStream

Inherited from:
EventStream
override def debugWith(debugger: Debugger[A]): EventStream[A]

See also debug convenience method in BaseObservable

See also debug convenience method in BaseObservable

Definition Classes
Inherited from:
EventStream
protected 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.

Inherited from:
Named
def delay(ms: Int): EventStream[A]
Value parameters:
ms

milliseconds of delay

Inherited from:
EventStream
def delaySync(after: EventStream[_]): EventStream[A]

Make a stream that emits this stream's values but waits for after stream to emit first in a given transaction. You can use this for Signals too with Signal.composeChanges (see docs for more details)

Make a stream that emits this stream's values but waits for after stream to emit first in a given transaction. You can use this for Signals too with Signal.composeChanges (see docs for more details)

Inherited from:
EventStream
final def displayName: String
Inherited from:
Named
def distinct: Self[A]

Distinct events (but keep all errors) by == (equals) comparison

Distinct events (but keep all errors) by == (equals) comparison

Inherited from:
BaseObservable
def distinctBy(isSame: (A, A) => Boolean): Self[A]

Distinct events (but keep all errors) using a comparison function

Distinct events (but keep all errors) using a comparison function

Inherited from:
BaseObservable
def distinctByKey(key: A => Any): Self[A]

Distinct events (but keep all errors) by matching key Note: key(event) might be evaluated more than once for each event

Distinct events (but keep all errors) by matching key Note: key(event) might be evaluated more than once for each event

Inherited from:
BaseObservable
def distinctByRef(implicit ev: A <:< AnyRef): Self[A]

Distinct events (but keep all errors) by reference equality (eq)

Distinct events (but keep all errors) by reference equality (eq)

Inherited from:
BaseObservable
def distinctErrors(isSame: (Throwable, Throwable) => Boolean): Self[A]

Distinct errors only (but keep all events) using a comparison function

Distinct errors only (but keep all events) using a comparison function

Inherited from:
BaseObservable
override def distinctTry(isSame: (Try[A], Try[A]) => Boolean): EventStream[A]

Distinct all values (both events and errors) using a comparison function

Distinct all values (both events and errors) using a comparison function

Definition Classes
Inherited from:
EventStream
def drop(numEvents: Int, resetOnStop: Boolean): EventStream[A]

Drop (skip) the first numEvents events from this stream. Note: errors are NOT dropped.

Drop (skip) the first numEvents events from this stream. Note: errors are NOT dropped.

Value parameters:
resetOnStop

Reset the count if the stream stops

Inherited from:
EventStream
def dropUntil(passes: A => Boolean, resetOnStop: Boolean): EventStream[A]

Drop (skip) events from this stream as long as they do NOT pass the test (as soon as they start passing, stop dropping) Note: errors are NOT dropped.

Drop (skip) events from this stream as long as they do NOT pass the test (as soon as they start passing, stop dropping) Note: errors are NOT dropped.

Value parameters:
passes

Note: MUST NOT THROW!

resetOnStop

Forget everything and start dropping again if the stream stops

Inherited from:
EventStream
def dropWhile(passes: A => Boolean, resetOnStop: Boolean): EventStream[A]

Drop (skip) events from this stream as long as they pass the test (as soon as they stop passing, stop dropping) Note: errors are NOT dropped.

Drop (skip) events from this stream as long as they pass the test (as soon as they stop passing, stop dropping) Note: errors are NOT dropped.

Value parameters:
passes

Note: MUST NOT THROW!

resetOnStop

Forget everything and start dropping again if the stream stops

Inherited from:
EventStream
final override def equals(obj: Any): Boolean

Airstream may internally use Scala library functions which use == or hashCode for equality, for example List.contains. Comparing observables by structural equality pretty much never makes sense, yet it's not that hard to run into that, all you need is to create a case class subclass, and the Scala compiler will generate a structural-equality equals and hashCode methods for you behind the scenes.

Airstream may internally use Scala library functions which use == or hashCode for equality, for example List.contains. Comparing observables by structural equality pretty much never makes sense, yet it's not that hard to run into that, all you need is to create a case class subclass, and the Scala compiler will generate a structural-equality equals and hashCode methods for you behind the scenes.

To prevent that, we make equals and hashCode methods final, using the default implementation (which is reference equality).

Definition Classes
Inherited from:
BaseObservable
def filter(passes: A => Boolean): EventStream[A]
Value parameters:
passes

Note: guarded against exceptions

Inherited from:
EventStream
def filterNot(predicate: A => Boolean): EventStream[A]
Inherited from:
EventStream
def filterWith[B](source: SignalSource[B], passes: B => Boolean): EventStream[A]

stream.filterWith(otherSignal, passes = _ == false) is essentially like stream.filter(_ => otherSignal.now() == false) (but it compiles)

stream.filterWith(otherSignal, passes = _ == false) is essentially like stream.filter(_ => otherSignal.now() == false) (but it compiles)

Inherited from:
EventStream
def flatMap[B, Inner[_], Output <: (Observable)](compose: A => Inner[B])(implicit strategy: FlattenStrategy[EventStream, Inner, Output]): Output[B]
Value parameters:
compose

Note: guarded against exceptions

Inherited from:
BaseObservable
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

Inherited from:
BaseObservable
final override def hashCode(): Int

Force reference equality checks. See comment for equals.

Force reference equality checks. See comment for equals.

Definition Classes
Inherited from:
BaseObservable
override def map[B](project: A => B): EventStream[B]
Value parameters:
project

Note: guarded against exceptions

Definition Classes
Inherited from:
EventStream
def mapTo[B](value: => B): Self[B]

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).

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 parameters:
value

Note: guarded against exceptions

Inherited from:
BaseObservable
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

Inherited from:
BaseObservable
def mapToUnit: Self[Unit]
Inherited from:
BaseObservable
def matchStreamOrSignal[B](ifStream: EventStream[A] => B, ifSignal: Signal[A] => B): B
Inherited from:
BaseObservable
def mergeWith[B >: A](streams: EventStream[B]*): EventStream[B]

Returns a stream that emits events from this stream AND all off the streams, interleaved. Note: For other types of combination, see combineWith, withCurrentValueOf, sample etc.

Returns a stream that emits events from this stream AND all off the streams, interleaved. Note: For other types of combination, see combineWith, withCurrentValueOf, sample etc.

Inherited from:
EventStream
override protected def numAllObservers: Int

Total number of internal and external observers

Total number of internal and external observers

Definition Classes
Inherited from:
WritableObservable
override def recover[B >: A](pf: PartialFunction[Throwable, Option[B]]): EventStream[B]

See docs for MapStream

See docs for MapStream

Value parameters:
pf

Note: guarded against exceptions

Definition Classes
Inherited from:
EventStream
def recoverIgnoreErrors: Self[A]
Inherited from:
BaseObservable
override def recoverToTry: EventStream[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
Inherited from:
EventStream
def scanLeft[B](initial: B)(fn: (B, A) => B): Signal[B]

A signal that emits the accumulated value every time that the parent stream emits.

A signal that emits the accumulated value every time that the parent stream emits.

Value parameters:
fn

Note: guarded against exceptions

Inherited from:
EventStream
def scanLeftRecover[B](initial: Try[B])(fn: (Try[B], Try[A]) => Try[B]): Signal[B]

A signal that emits the accumulated value every time that the parent stream emits.

A signal that emits the accumulated value every time that the parent stream emits.

Value parameters:
fn

Note: Must not throw!

Inherited from:
EventStream
def setDisplayName(name: String): Named.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
Inherited from:
Named
def startWith[B >: A](initial: => B, cacheInitialValue: Boolean): Signal[B]
Value parameters:
cacheInitialValue

if false, signal's initial value will be re-evaluated on every restart (so long as the parent stream does not emit any values)

Inherited from:
EventStream
def startWithNone: Signal[Option[A]]
Inherited from:
EventStream
def startWithTry[B >: A](initial: => Try[B], cacheInitialValue: Boolean): Signal[B]
Value parameters:
cacheInitialValue

if false, signal's initial value will be re-evaluated on every restart (so long as the parent stream does not emit any values)

Inherited from:
EventStream
def take(numEvents: Int, resetOnStop: Boolean): EventStream[A]

Take the first numEvents events from this stream, ignore the rest. Note: As long as events are being taken, ALL errors are also taken

Take the first numEvents events from this stream, ignore the rest. Note: As long as events are being taken, ALL errors are also taken

Value parameters:
resetOnStop

Reset the count if the stream stops

Inherited from:
EventStream
def takeUntil(passes: A => Boolean, resetOnStop: Boolean): EventStream[A]

Imitate parent stream as long as events to NOT pass the test; stop emitting after that.

Imitate parent stream as long as events to NOT pass the test; stop emitting after that.

Value parameters:
passes

Note: MUST NOT THROW!

resetOnStop

Forget everything and start dropping again if the stream stops

Inherited from:
EventStream
def takeWhile(passes: A => Boolean, resetOnStop: Boolean): EventStream[A]

Imitate parent stream as long as events pass the test; stop emitting after that.

Imitate parent stream as long as events pass the test; stop emitting after that.

Value parameters:
passes

Note: MUST NOT THROW!

resetOnStop

Forget everything and start dropping again if the stream stops

Inherited from:
EventStream
def throttle(ms: Int, leading: Boolean): EventStream[A]

See docs for ThrottleStream

See docs for ThrottleStream

Inherited from:
EventStream
def throwFailure[B](implicit ev: A <:< Try[B]): Self[B]

Unwrap Try to "undo" recoverToTry – Encode Failure(err) as observable errors, and Success(v) as events

Unwrap Try to "undo" recoverToTry – Encode Failure(err) as observable errors, and Success(v) as events

Inherited from:
BaseObservable
override def toObservable: EventStream[A]
Definition Classes
Inherited from:
EventStream
def toSignal[B >: A](initial: => B, cacheInitialValue: Boolean): Signal[B]
Value parameters:
cacheInitialValue

if false, signal's initial value will be re-evaluated on every restart (so long as the parent stream does not emit any values)

Inherited from:
EventStream
def toSignalIfStream[B >: A](ifStream: EventStream[A] => Signal[B]): Signal[B]
Inherited from:
BaseObservable
def toSignalWithTry[B >: A](initial: => Try[B], cacheInitialValue: Boolean): Signal[B]
Value parameters:
cacheInitialValue

if false, signal's initial value will be re-evaluated on every restart (so long as the parent stream does not emit any values)

Inherited from:
EventStream
def toStreamIfSignal[B >: A](ifSignal: Signal[A] => EventStream[B]): EventStream[B]
Inherited from:
BaseObservable
final override def toString: String

Override defaultDisplayName instead of this, if you need to.

Override defaultDisplayName instead of this, if you need to.

Definition Classes
Named -> Any
Inherited from:
Named
def toWeakSignal: Signal[Option[A]]

Convert this observable to a signal of Option[A]. If it is a stream, set initial value to None.

Convert this observable to a signal of Option[A]. If it is a stream, set initial value to None.

Inherited from:
BaseObservable

Deprecated and Inherited methods

def foldLeft[B](initial: B)(fn: (B, A) => B): Signal[B]
Deprecated
Inherited from:
EventStream
def foldLeftRecover[B](initial: Try[B])(fn: (Try[B], Try[A]) => Try[B]): Signal[B]
Deprecated
Inherited from:
EventStream

Inherited fields

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.

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.

Inherited from:
WritableObservable

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

Inherited from:
WritableObservable