scalaz.effect.IORef.scala Maven / Gradle / Ivy

package scalaz
package effect

import ST._

/**
 * A mutable reference in the IO monad. Note that unsafePerformIO will allow leaking
 * such a reference out of the monad, but any operations on a leaked reference are still monadic.
 */
sealed abstract class IORef[A] {
  val value: STRef[IvoryTower, A]

  def read: IO[A] = STToIO(value.read)

  def write(a: => A): IO[Unit] = STToIO(value.write(a) map (_ => ()))

  def mod(f: A => A): IO[A] = STToIO(value.mod(f) flatMap (_.read))
}

object IORef extends IORefs

trait IORefs {
  private[effect] def ioRef[A](v: STRef[IvoryTower, A]): IORef[A] = new IORef[A] {
    val value = v
  }
}