Packages

object Pull extends PullLowPriority

Source
Pull.scala
Linear Supertypes
PullLowPriority, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Pull
  2. PullLowPriority
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. sealed abstract class Cancellable[+F[_], +R] extends AnyRef

    Result of acquireCancellable.

  2. final class PartiallyAppliedFromEither[F[_]] extends AnyRef

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. def acquire[F[_], R](r: F[R])(cleanup: (R) ⇒ F[Unit])(implicit arg0: RaiseThrowable[F]): Pull[F, INothing, R]

    Acquire a resource within a Pull.

    Acquire a resource within a Pull. The cleanup action will be run at the end of the .stream scope which executes the returned Pull. The acquired resource is returned as the result value of the pull.

  5. def acquireCancellable[F[_], R](r: F[R])(cleanup: (R) ⇒ F[Unit])(implicit arg0: RaiseThrowable[F]): Pull[F, INothing, Cancellable[F, R]]

    Like acquire but the result value consists of a cancellation pull and the acquired resource.

    Like acquire but the result value consists of a cancellation pull and the acquired resource. Running the cancellation pull frees the resource. This allows the acquired resource to be released earlier than at the end of the containing pull scope.

  6. def acquireCancellableCase[F[_], R](r: F[R])(cleanup: (R, ExitCase[Throwable]) ⇒ F[Unit])(implicit arg0: RaiseThrowable[F]): Pull[F, INothing, Cancellable[F, R]]

    Like acquireCancellable but provides an ExitCase[Throwable] to the cleanup action, indicating the cause for cleanup execution.

  7. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  8. def attemptEval[F[_], R](fr: F[R]): Pull[F, INothing, Either[Throwable, R]]

    Like eval but if the effectful value fails, the exception is returned in a Left instead of failing the pull.

  9. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate() @throws( ... )
  10. val done: Pull[Pure, INothing, Unit]

    The completed Pull.

    The completed Pull. Reads and outputs nothing.

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  13. def eval[F[_], R](fr: F[R]): Pull[F, INothing, R]

    Evaluates the supplied effectful value and returns the result as the resource of the returned pull.

  14. def fromEither[F[x]]: PartiallyAppliedFromEither[F]

    Lifts an Either[Throwable, A] to an effectful Pull[F, A, Unit].

    Lifts an Either[Throwable, A] to an effectful Pull[F, A, Unit].

    Example: 

    1. scala> import cats.effect.IO, scala.util.Try
scala> Pull.fromEither[IO](Right(42)).stream.compile.toList.unsafeRunSync()
res0: List[Int] = List(42)
scala> Try(Pull.fromEither[IO](Left(new RuntimeException)).stream.compile.toList.unsafeRunSync())
res1: Try[List[INothing]] = Failure(java.lang.RuntimeException)
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. def loop[F[_], O, R](using: (R) ⇒ Pull[F, O, Option[R]]): (R) ⇒ Pull[F, O, Option[R]]

    Repeatedly uses the output of the pull as input for the next step of the pull.

    Repeatedly uses the output of the pull as input for the next step of the pull. Halts when a step terminates with None or Pull.raiseError.

  19. implicit def monadInstance[F[_], O]: Monad[[γ$11$]Pull[F, O, γ$11$]]
    Definition Classes
    PullLowPriority
  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. def output[F[x] >: Pure[x], O](os: Chunk[O]): Pull[F, O, Unit]

    Outputs a chunk of values.

  24. def output1[F[x] >: Pure[x], O](o: O): Pull[F, O, Unit]

    Outputs a single value.

  25. def pure[F[x] >: Pure[x], R](r: R): Pull[F, INothing, R]

    Pull that outputs nothing and has result of r.

  26. def raiseError[F[_]](err: Throwable)(implicit arg0: RaiseThrowable[F]): Pull[F, INothing, INothing]

    Reads and outputs nothing, and fails with the given error.

    Reads and outputs nothing, and fails with the given error.

    The F type must be explicitly provided (e.g., via raiseError[IO] or raiseError[Fallible]).

  27. def suspend[F[x] >: Pure[x], O, R](p: ⇒ Pull[F, O, R]): Pull[F, O, R]

    Returns a pull that evaluates the supplied by-name each time the pull is used, allowing use of a mutable value in pull computations.

  28. implicit def syncInstance[F[_], O](implicit ev: ApplicativeError[F, Throwable]): Sync[[γ$8$]Pull[F, O, γ$8$]]

    Sync instance for Pull.

  29. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  30. def toString(): String
    Definition Classes
    AnyRef → Any
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  33. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  34. object Cancellable

Deprecated Value Members

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

    (Since version ) see corresponding Javadoc for more information.

Inherited from PullLowPriority

Inherited from AnyRef

Inherited from Any

Ungrouped