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. implicit def InvariantOps[F[_], O, R](p: Pull[F, O, R]): InvariantOps[F, O, R]

   

   Provides syntax for pulls that are invariant in F, O, and R.

6. implicit def PureOps[O, R](p: Pull[Pure, O, R]): PureOps[O, R]

   

   Provides syntax for pure pulls.

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

8. def acquireCancellable[F[_], R](r: F[R])(cleanup: (R) ⇒ F[Unit]): Pull[F, Nothing, 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.

9. final def asInstanceOf[T0]: T0

   

   Definition Classes

   Any

10. def attemptEval[F[_], R](fr: F[R]): Pull[F, Nothing, Either[Throwable, R]]

    

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

11. def clone(): AnyRef

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

12. implicit def covaryPure[F[_], O, R, O2 >: O, R2 >: R](p: Pull[Pure, O, R]): Pull[F, O2, R2]

    

    Implicitly covaries a pull.

13. val done: Pull[Nothing, Nothing, Unit]

    

    The completed Pull.

    The completed Pull. Reads and outputs nothing.

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

    

    Definition Classes

    AnyRef

15. def equals(arg0: Any): Boolean

    

    Definition Classes

    AnyRef → Any

16. def eval[F[_], R](fr: F[R]): Pull[F, Nothing, R]

    

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

17. def fail(err: Throwable): Pull[Nothing, Nothing, Nothing]

    

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

18. def finalize(): Unit

    

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

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

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

    

    Definition Classes

    AnyRef → Any

20. def hashCode(): Int

    

    Definition Classes

    AnyRef → Any

21. final def isInstanceOf[T0]: Boolean

    

    Definition Classes

    Any

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

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

    

    Definition Classes

    AnyRef

24. final def notify(): Unit

    

    Definition Classes

    AnyRef

25. final def notifyAll(): Unit

    

    Definition Classes

    AnyRef

26. def output[F[_], O](os: Segment[O, Unit]): Pull[F, O, Unit]

    

    Ouptuts a segment of values.

27. def output1[F[_], O](o: O): Pull[F, O, Unit]

    

    Ouptuts a single value.

28. def pure[F[_], R](r: R): Pull[F, Nothing, R]

    

    Pull that outputs nothing and has result of r.

29. def segment[F[_], O, R](s: Segment[O, R]): Pull[F, O, R]

    

    Pull that outputs the specified segment and returns the result of the segment as the result of the pull.

    Pull that outputs the specified segment and returns the result of the segment as the result of the pull. Less efficient than output.

30. def suspend[F[_], 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.

31. def syncInstance[F[_], O]: Sync[[γ$10$]Pull[F, O, γ$10$]]

    

    Sync instance for Stream.

    Sync instance for Stream.

    Note: non-implicit so that cats syntax doesn't override FS2 syntax

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

    

    Definition Classes

    AnyRef

33. def toString(): String

    

    Definition Classes

    AnyRef → Any

34. final def wait(): Unit

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

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

    

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )