Class/Object

fs2.async.mutable

Signal

Related Docs: object Signal | package mutable

Permalink

abstract class Signal[F[_], A] extends immutable.Signal[F, A]

Data type of a single value of type A that can be read and written in the effect F.

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

Instance Constructors

  1. new Signal()

    Permalink

Abstract Value Members

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

    Permalink

    Returns the continuous version of this signal, which emits the current A value on each request for an element from the stream.

    Returns the continuous version of this signal, which emits the current A value on each request for an element from the stream.

    Note that this may not see all changes of A as it always gets the current A at each request for an element.

    Definition Classes
    Signal

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

    Permalink

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

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

    The value _may_ change several times between reads, but it is guaranteed the latest value will be emitted after a series of changes.

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

    Definition Classes
    Signal

  3. abstract def get: F[A]

    Permalink

    Asynchronously gets the current value of this Signal.

    Asynchronously gets the current value of this Signal.

    Definition Classes
    Signal

  4. abstract def modify[B](f: (A) ⇒ (A, B)): F[B]

    Permalink

    Like update but allows the update function to return an output value of type B

  5. abstract def refresh: F[Unit]

    Permalink

    Asynchronously refreshes the value of the signal, keeping the value of this Signal the same, but notifing any listeners.

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

    Permalink

    Sets the value of this Signal.

  7. abstract def update(f: (A) ⇒ A): F[Unit]

    Permalink

    Updates the current value using the supplied update function.

    Updates the current value using the supplied update function. If another modification occurs between the time the current value is read and subsequently updated, the modification is retried using the new value. Hence, f may be invoked multiple times.

    Satisfies: r.modify(_ => a) == r.set(a)

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 two functions, A => B and B => A.

  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