• Home
• io.github.endless4s
• endless-core_3
• 0.27.0
• source code
• StateWriter.scala

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

endless.core.entity.StateWriter.scala Maven / Gradle / Ivy

package endless.core.entity

/** `StateWriter[F, S]` is the ability to write a value of type `S`, where that value is
  * semantically understood as the new state of the entity.
  *
  * @tparam F
  *   context
  * @tparam S
  *   state
  */
trait StateWriter[F[_], S] {

  /** Write the entity state
    * @param s
    *   entity state
    * @return
    *   unit in `F` context
    */
  def write(s: S): F[Unit]

  /** Modify the entity state with the given function
    * @param f
    *   state modifier
    * @return
    *   unit in `F` context
    */
  def modify(f: S => S): F[Unit]

  /** Modify the entity state with the given function expressed in `F` context
    * @param f
    *   state modifier in `F` context
    * @return
    *   unit in `F` context
    */
  def modifyF(f: S => F[S]): F[Unit]
}