trait StateAccess[F[_], S] extends Write[F, 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, S], ModState[F, S], SetState[F, S], Base[F], 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. All

Type Members

  1. final type State = S
  2. abstract type WithEffect[F2[_]] <: StateAccess[F2[_], S]
  3. abstract type WithMappedState[S2] <: StateAccess[F, S2]

Abstract Value Members

  1. implicit abstract def F: Effect[F]
    Attributes
    protected
    Definition Classes
    Base
  2. abstract def modStateOption(mod: (S) ⇒ Option[S], callback: Callback): F[Unit]

    callback

    Executed regardless of whether state is changed.

    Definition Classes
    ModState
  3. abstract def setStateOption(newState: Option[S], callback: Callback): F[Unit]

    callback

    Executed regardless of whether state is changed.

    Definition Classes
    SetState
  4. abstract def state: F[State]
  5. abstract def withEffect[F2[_]](implicit t: Trans[F, F2]): WithEffect[F2]
  6. abstract def xmapState[S2](f: (S) ⇒ S2)(g: (S2) ⇒ S): WithMappedState[S2]
  7. 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: (Callback) ⇒ F[Unit]): AsyncCallback[Unit]
    Attributes
    protected
    Definition Classes
    Base
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  7. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  8. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. def modState(mod: (S) ⇒ S, callback: Callback): F[Unit]

    callback

    Executed after state is changed.

    Definition Classes
    ModState
  13. final def modState(mod: (S) ⇒ S): F[Unit]
    Definition Classes
    ModState
  14. final def modStateAsync(mod: (S) ⇒ S): AsyncCallback[Unit]
    Definition Classes
    ModState
  15. final def modStateOption(mod: (S) ⇒ Option[S]): F[Unit]
    Definition Classes
    ModState
  16. final def modStateOptionAsync(mod: (S) ⇒ Option[S]): AsyncCallback[Unit]
    Definition Classes
    ModState
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  19. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  20. def setState(newState: S, callback: Callback): F[Unit]

    callback

    Executed after state is changed.

    Definition Classes
    SetState
  21. final def setState(newState: S): F[Unit]
    Definition Classes
    SetState
  22. final def setStateAsync(newState: S): AsyncCallback[Unit]
    Definition Classes
    SetState
  23. final def setStateOption(newState: Option[S]): F[Unit]
    Definition Classes
    SetState
  24. final def setStateOptionAsync(newState: Option[S]): AsyncCallback[Unit]
    Definition Classes
    SetState
  25. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  26. def toModStateFn: ModStateFn[F, S]
    Definition Classes
    ModState
  27. def toSetStateFn: SetStateFn[F, S]
    Definition Classes
    SetState
  28. def toString(): String
    Definition Classes
    AnyRef → Any
  29. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  31. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def withEffectsImpure(implicit t: Trans[F, Id]): WithEffect[Id]
  33. final def withEffectsPure(implicit t: Trans[F, CallbackTo]): WithEffect[CallbackTo]

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from Write[F, S]

Inherited from ModState[F, S]

Inherited from SetState[F, S]

Inherited from Base[F]

Inherited from AnyRef

Inherited from Any

Ungrouped