Pull

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. object Cancellable

   

5. 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.

6. 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.

7. 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.

8. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

9. 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.

10. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

11. val done: Pull[Pure, INothing, Unit]

    

    The completed Pull.

    The completed Pull. Reads and outputs nothing.

12. final def eq(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

13. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

14. 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.

15. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

16. 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)

17. final def getClass(): Class[_]

    

    Definition Classes

    AnyRef → Any

18. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

19. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

20. 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.

21. implicit def monadInstance[F[_], O]: Monad[[γ$9$]Pull[F, O, γ$9$]]

    

    Definition Classes

    PullLowPriority

22. final def ne(arg0: AnyRef): Boolean

    

    Definition Classes

    AnyRef

23. final def notify(): Unit

    

    Definition Classes

    AnyRef

24. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

25. def output[F[x] >: Pure[x], O](os: Chunk[O]): Pull[F, O, Unit]

    

    Outputs a chunk of values.

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

    

    Outputs a single value.

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

    

    Pull that outputs nothing and has result of r.

28. 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]).

29. 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.

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

    

    Sync instance for Pull.

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

    

    Definition Classes

    AnyRef

32. def toString(): String

    

    Definition Classes

    AnyRef → Any

33. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

34. final def wait(arg0: Long, arg1: Int): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

35. final def wait(arg0: Long): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )