trait StateAccess[F[_], A[_], S] extends Write[F, A, S]

Base class for something that has read/write state access (under the same effect type).

Passing this around (top-level) is fine but do not use it in a generic/library/helper method. In intermediary positions, use StateAccessor instead.

F

The type of effect when accessing state.

S

State type.

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

Type Members

  1. final type State = S
  2. abstract type WithAsyncEffect[G[_]] <: StateAccess[F, G[_], S]
    Definition Classes
    StateAccess → Write → ModState → SetState → Base
  3. abstract type WithEffect[G[_]] <: StateAccess[G[_], A, S]
    Definition Classes
    StateAccess → Write → ModState → SetState → Base
  4. abstract type WithMappedState[S2] <: StateAccess[F, A, S2]

Abstract Value Members

  1. implicit abstract def A: Async[A]
    Attributes
    protected
    Definition Classes
    Base
  2. implicit abstract def F: UnsafeSync[F]
    Attributes
    protected
    Definition Classes
    Base
  3. abstract 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
    ModState
  4. abstract 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
    SetState
  5. abstract def state: F[State]
  6. abstract def withAsyncEffect[G[_]](implicit G: Async[G]): WithAsyncEffect[G]
    Definition Classes
    Base
  7. abstract def withEffect[G[_]](implicit G: UnsafeSync[G]): WithEffect[G]
    Definition Classes
    Base
  8. abstract def xmapState[S2](f: (S) => S2)(g: (S2) => S): WithMappedState[S2]
  9. abstract def zoomState[S2](get: (S) => S2)(set: (S2) => (S) => S): WithMappedState[S2]

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

    callback

    Executed after state is changed.

    Definition Classes
    ModState
  14. final def modState(mod: (S) => S): F[Unit]
    Definition Classes
    ModState
  15. final def modStateAsync(mod: (S) => S): A[Unit]
    Definition Classes
    ModState
  16. final def modStateOption(mod: (S) => Option[S]): F[Unit]
    Definition Classes
    ModState
  17. final def modStateOptionAsync(mod: (S) => Option[S]): A[Unit]
    Definition Classes
    ModState
  18. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def setState[G[_]](newState: S, callback: => G[Unit])(implicit G: Dispatch[G]): F[Unit]

    callback

    Executed after state is changed.

    Definition Classes
    SetState
  22. final def setState(newState: S): F[Unit]
    Definition Classes
    SetState
  23. final def setStateAsync(newState: S): A[Unit]
    Definition Classes
    SetState
  24. final def setStateOption(newState: Option[S]): F[Unit]
    Definition Classes
    SetState
  25. final def setStateOptionAsync(newState: Option[S]): A[Unit]
    Definition Classes
    SetState
  26. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  27. def toModStateFn: ModStateFn[F, A, S]
    Definition Classes
    ModState
  28. def toSetStateFn: SetStateFn[F, A, S]
    Definition Classes
    SetState
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  33. final def withEffectsImpure: WithEffect[Id]
    Definition Classes
    Base
  34. final def withEffectsPure: WithEffect[Sync]
    Definition Classes
    Base

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