Trait/Object

fs2.async.mutable

Signal

Related Docs: object Signal | package mutable

Permalink

trait Signal[F[_], A] extends immutable.Signal[F, A]

A signal whose value may be set asynchronously. Provides continuous and discrete streams for responding to changes to it's value.

Self Type
Signal[F, A]
Source
Signal.scala
Linear Supertypes
immutable.Signal[F, A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Signal
  2. Signal
  3. AnyRef
  4. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def changes: Stream[F, Unit]

    Permalink

    Returns the discrete version of changed.

    Returns the discrete version of changed. Will emit Unit when the value is changed.

    Definition Classes
    Signal

  2. abstract def continuous: Stream[F, A]

    Permalink

    Returns the continuous version of this signal, always equal to the current A inside value.

    Returns the continuous version of this signal, always equal to the current A inside value.

    Note that this may not see all changes of A as it gets always current fresh A at every request.

    Definition Classes
    Signal

  3. abstract def discrete: Stream[F, A]

    Permalink

    Returns the discrete version stream of this signal, updated only when value is changed.

    Returns the discrete version stream of this signal, updated only when value is changed.

    Value _may_ change several times between reads, but it is guaranteed this will always get latest known value after any change.

    If you want to be notified about every single change use async.queue for signalling.

    It will emit the current value of the Signal after being run or when the signal is set for the first time

    Definition Classes
    Signal

  4. abstract def get: F[A]

    Permalink

    Asynchronously get the current value of this Signal

    Asynchronously get the current value of this Signal

    Definition Classes
    Signal

  5. abstract def modify(f: (A) ⇒ A): F[Change[A]]

    Permalink

    Asynchronously sets the current value of this Signal and returns new value of this Signal.

    Asynchronously sets the current value of this Signal and returns new value of this Signal.

    f is consulted to set this signal.

    F returns the result of applying op to current value.

  6. abstract def modify2[B](f: (A) ⇒ (A, B)): F[(Change[A], B)]

    Permalink

    like modify but allows to extract B from A and return it together with Change

  7. abstract def refresh: F[Unit]

    Permalink

    Asynchronously refreshes the value of the signal, keep the value of this Signal the same, but notify any listeners.

  8. abstract def set(a: A): F[Unit]

    Permalink

    Sets the value of this Signal.

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Signal[F, A] to any2stringadd[Signal[F, A]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd

  4. def ->[B](y: B): (Signal[F, A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Signal[F, A] to ArrowAssoc[Signal[F, A]] performed by method ArrowAssoc in scala.Predef. This conversion will take place only if A is Boolean (A =:= Boolean).
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  8. def ensuring(cond: (Signal[F, A]) ⇒ Boolean, msg: ⇒ Any): Signal[F, A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Signal[F, A] to Ensuring[Signal[F, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  9. def ensuring(cond: (Signal[F, A]) ⇒ Boolean): Signal[F, A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Signal[F, A] to Ensuring[Signal[F, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  10. def ensuring(cond: Boolean, msg: ⇒ Any): Signal[F, A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Signal[F, A] to Ensuring[Signal[F, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: Boolean): Signal[F, A]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Signal[F, A] to Ensuring[Signal[F, A]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Signal[F, A] to StringFormat[Signal[F, A]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  18. def imap[B](f: (A) ⇒ B)(g: (B) ⇒ A)(implicit F: Functor[F]): Signal[F, B]

    Permalink

    Returns an alternate view of this Signal where its elements are of type B, given a function from A to B.

  19. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  20. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  21. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  22. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  23. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  24. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  25. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  26. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  27. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  28. def →[B](y: B): (Signal[F, A], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Signal[F, A] to ArrowAssoc[Signal[F, A]] performed by method ArrowAssoc in scala.Predef. This conversion will take place only if A is Boolean (A =:= Boolean).
    Definition Classes
    ArrowAssoc

Inherited from immutable.Signal[F, A]

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Signal[F, A] to any2stringadd[Signal[F, A]]

Inherited by implicit conversion StringFormat from Signal[F, A] to StringFormat[Signal[F, A]]

Inherited by implicit conversion Ensuring from Signal[F, A] to Ensuring[Signal[F, A]]

Inherited by implicit conversion ArrowAssoc from Signal[F, A] to ArrowAssoc[Signal[F, A]]

Ungrouped