Packages

final class StateSnapshotF[F[_], A[_], S] extends Write[F, A, S]

Linear Supertypes
Write[F, A, S], ModState[F, A, S], SetState[F, A, S], Base[F, A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StateSnapshotF
  2. Write
  3. ModState
  4. SetState
  5. Base
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new StateSnapshotF(value: S, underlyingSetFn: Reusable[SetFn[F, S]], reusability: Reusability[S])(implicit FF: UnsafeSync[F], AA: Async[A])

Type Members

  1. type WithAsyncEffect[G[_]] = StateSnapshotF[F, G, S]
    Definition Classes
    StateSnapshotF → Write → ModState → SetState → Base
  2. type WithEffect[G[_]] = StateSnapshotF[G, A, S]
    Definition Classes
    StateSnapshotF → Write → ModState → SetState → Base

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. implicit def A: Async[A]
    Attributes
    protected
    Definition Classes
    StateSnapshotF → Base
  5. implicit def F: UnsafeSync[F]
    Attributes
    protected
    Definition Classes
    StateSnapshotF → Base
  6. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  7. final def async(f: (Sync[Unit]) => F[Unit]): A[Unit]
    Attributes
    protected
    Definition Classes
    Base
  8. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @HotSpotIntrinsicCandidate() @native()
  9. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  10. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  12. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  13. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  14. def modState[G[_]](mod: (S) => S, callback: => G[Unit])(implicit G: Dispatch[G]): F[Unit]
    Definition Classes
    ModState
  15. final def modState(mod: (S) => S): F[Unit]
    Definition Classes
    ModState
  16. final def modStateAsync(mod: (S) => S): A[Unit]
    Definition Classes
    ModState
  17. def modStateOption[G[_]](mod: (S) => Option[S], callback: => G[Unit])(implicit G: Dispatch[G]): F[Unit]

    callback

    Executed regardless of whether state is changed.

    Definition Classes
    StateSnapshotF → ModState
  18. final def modStateOption(mod: (S) => Option[S]): F[Unit]
    Definition Classes
    ModState
  19. final def modStateOptionAsync(mod: (S) => Option[S]): A[Unit]
    Definition Classes
    ModState
  20. def narrowOption[T <: S](implicit arg0: ClassTag[T]): Option[StateSnapshotF[F, A, T]]

    returns

    None if value: S isn't value: T as well.

  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate() @native()
  24. def setState[G[_]](newState: S, callback: => G[Unit])(implicit G: Dispatch[G]): F[Unit]
    Definition Classes
    SetState
  25. final def setState(newState: S): F[Unit]
    Definition Classes
    SetState
  26. final def setStateAsync(newState: S): A[Unit]
    Definition Classes
    SetState
  27. def setStateOption[G[_]](newState: Option[S], callback: => G[Unit])(implicit G: Dispatch[G]): F[Unit]

    callback

    Executed regardless of whether state is changed.

    Definition Classes
    StateSnapshotF → SetState
  28. final def setStateOption(newState: Option[S]): F[Unit]
    Definition Classes
    SetState
  29. final def setStateOptionAsync(newState: Option[S]): A[Unit]
    Definition Classes
    SetState
  30. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  31. def toModStateFn: ModStateFn[F, A, S]
    Definition Classes
    ModState
  32. def toSetStateFn: SetStateFn[F, A, S]
    Definition Classes
    SetState
  33. def toString(): String
    Definition Classes
    StateSnapshotF → AnyRef → Any
  34. val underlyingSetFn: Reusable[SetFn[F, S]]
  35. def unsafeWiden[T >: S](implicit ct: ClassTag[S]): StateSnapshotF[F, A, T]

    Unsafe because writes may be dropped.

    Unsafe because writes may be dropped.

    Eg. if you widen a StateSnapshot[Banana] into StateSnapshot[Food], calling setState(banana2) will work but setState(pasta) will be silently ignored.

  36. val value: S
  37. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  38. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  39. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  40. def withAsyncEffect[G[_]](implicit G: Async[G]): WithAsyncEffect[G]
    Definition Classes
    StateSnapshotF → Base
  41. def withEffect[G[_]](implicit G: UnsafeSync[G]): WithEffect[G]
    Definition Classes
    StateSnapshotF → Base
  42. final def withEffectsImpure: WithEffect[Id]
    Definition Classes
    Base
  43. final def withEffectsPure: WithEffect[Sync]
    Definition Classes
    Base
  44. def withReuse: InstanceMethodsWithReuse[F, A, S]
  45. def withValue(s: S): StateSnapshotF[F, A, S]

    THIS WILL VOID REUSABILITY.

    THIS WILL VOID REUSABILITY.

    The resulting StateSnapshotF[F, A, S] will not be reusable.

  46. def xmapState[T](f: (S) => T)(g: (T) => S): StateSnapshotF[F, A, T]

    THIS WILL VOID REUSABILITY.

    THIS WILL VOID REUSABILITY.

    The resulting StateSnapshot[T] will not be reusable.

  47. def zoomState[T](f: (S) => T)(g: (T) => (S) => S): StateSnapshotF[F, A, T]

    THIS WILL VOID REUSABILITY.

    THIS WILL VOID REUSABILITY.

    The resulting StateSnapshot[T] will not be reusable.

  48. def zoomStateOption[T](f: (S) => Option[T])(g: (T) => (S) => S): Option[StateSnapshotF[F, A, T]]

    THIS WILL VOID REUSABILITY.

    THIS WILL VOID REUSABILITY.

    The resulting StateSnapshot[T] will not be reusable.

Deprecated Value Members

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

    (Since version 9)

Inherited from Write[F, A, S]

Inherited from ModState[F, A, S]

Inherited from SetState[F, A, S]

Inherited from Base[F, A]

Inherited from AnyRef

Inherited from Any

Ungrouped