scalaz.Free

Return

case class Return[S[+_], +A](a: A)(implicit evidence$1: Functor[S]) extends Free[S, A] with Product with Serializable

Return from the computation with the given value.

Source
Free.scala
Linear Supertypes
Serializable, Serializable, Product, Equals, Free[S, A], AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Return
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. Free
  7. AnyRef
  8. Any
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Return(a: A)(implicit arg0: Functor[S])

Value Members

  1. final def !=(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Definition Classes
    Any
  3. final def ##(): Int

    Definition Classes
    AnyRef → Any
  4. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  5. final def ==(arg0: Any): Boolean

    Definition Classes
    Any
  6. final def >>=[B](f: (A) ⇒ Free[S, B]): Free[S, B]

    Alias for flatMap

    Alias for flatMap

    Definition Classes
    Free
  7. val a: A

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any
  9. final def bounce[AA >: A](f: (S[Free[S, A]]) ⇒ Free[S, AA]): Free[S, AA]

    Runs a single step, using a function that extracts the resumption from its suspension functor.

    Runs a single step, using a function that extracts the resumption from its suspension functor.

    Definition Classes
    Free
  10. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  11. def collect[B, C >: A](implicit ev: <~<[Free[S, C], Source[B, C]]): (Vector[B], C)

    Runs a Source all the way to the end, tail-recursively, collecting the produced values.

    Runs a Source all the way to the end, tail-recursively, collecting the produced values.

    Definition Classes
    Free
  12. def drain[E, B, C >: A](source: Source[E, B])(implicit ev: <~<[Free[S, C], Sink[E, C]]): (C, B)

    Feed the given source to this Sink.

    Feed the given source to this Sink.

    Definition Classes
    Free
  13. def drive[E, B, C >: A](sink: Sink[Option[E], B])(implicit ev: <~<[Free[S, C], Source[E, C]]): (C, B)

    Drive this Source with the given Sink.

    Drive this Source with the given Sink.

    Definition Classes
    Free
  14. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  15. def feed[E, C >: A](ss: Stream[E])(implicit ev: <~<[Free[S, C], Sink[E, C]]): C

    Feed the given stream to this Source.

    Feed the given stream to this Source.

    Definition Classes
    Free
  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  17. final def flatMap[B](f: (A) ⇒ Free[S, B]): Free[S, B]

    Binds the given continuation to the result of this computation.

    Binds the given continuation to the result of this computation. All left-associated binds are reassociated to the right.

    Definition Classes
    Free
  18. final def foldRun[B, AA >: A](b: B)(f: (B, S[Free[S, AA]]) ⇒ (B, Free[S, AA])): (B, AA)

    Runs to completion, allowing the resumption function to thread an arbitrary state of type B.

    Runs to completion, allowing the resumption function to thread an arbitrary state of type B.

    Definition Classes
    Free
  19. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  20. final def go[AA >: A](f: (S[Free[S, AA]]) ⇒ Free[S, AA]): AA

    Runs to completion, using a function that extracts the resumption from its suspension functor.

    Runs to completion, using a function that extracts the resumption from its suspension functor.

    Definition Classes
    Free
  21. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any
  22. final def map[B](f: (A) ⇒ B): Free[S, B]

    Definition Classes
    Free
  23. final def mapFirstSuspension(f: ~>[S, S]): Free[S, A]

    Modifies the first suspension with the given natural transformation.

    Modifies the first suspension with the given natural transformation.

    Definition Classes
    Free
  24. final def mapSuspension[T[+_]](f: ~>[S, T])(implicit arg0: Functor[T]): Free[T, A]

    Changes the suspension functor by the given natural transformation.

    Changes the suspension functor by the given natural transformation.

    Definition Classes
    Free
  25. final def ne(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  26. final def notify(): Unit

    Definition Classes
    AnyRef
  27. final def notifyAll(): Unit

    Definition Classes
    AnyRef
  28. final def resume: \/[S[Free[S, A]], A]

    Evaluates a single layer of the free monad.

    Evaluates a single layer of the free monad.

    Definition Classes
    Free
    Annotations
    @tailrec()
  29. def run[B >: A](implicit ev: <~<[Free[S, B], Trampoline[B]]): B

    Runs a trampoline all the way to the end, tail-recursively.

    Runs a trampoline all the way to the end, tail-recursively.

    Definition Classes
    Free
  30. final def runM[M[_], AA >: A](f: (S[Free[S, AA]]) ⇒ M[Free[S, AA]])(implicit arg0: Monad[M]): M[AA]

    Definition Classes
    Free
    Since

    7.0.1

  31. final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes
    AnyRef
  32. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  33. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def zap[G[+_], B](fs: Cofree[G, (A) ⇒ B])(implicit G: Functor[G], d: Zap[S, G]): B

    Applies a function in a comonad to the corresponding value in this monad, annihilating both.

    Applies a function in a comonad to the corresponding value in this monad, annihilating both.

    Definition Classes
    Free
  36. final def zapWith[G[+_], B, C](bs: Cofree[G, B])(f: (A, B) ⇒ C)(implicit G: Functor[G], d: Zap[S, G]): C

    Applies a function f to a value in this monad and a corresponding value in the dual comonad, annihilating both.

    Applies a function f to a value in this monad and a corresponding value in the dual comonad, annihilating both.

    Definition Classes
    Free
  37. def zipWith[B, C](tb: Free[S, B], f: (A, B) ⇒ C): Free[S, C]

    Interleave this computation with another, combining the results with the given function.

    Interleave this computation with another, combining the results with the given function.

    Definition Classes
    Free

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Free[S, A]

Inherited from AnyRef

Inherited from Any

Ungrouped