Class/Object

fs2

Scope

Related Docs: object Scope | package fs2

Permalink

abstract class Scope[F[_]] extends AnyRef

Represents a period of stream execution in which resources are acquired and released.

Note: this type is generally used to implement low-level actions that manipulate resource lifetimes and hence, isn't generally used by user-level code.

Source
Scope.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Scope
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by StringFormat
  3. by Ensuring
  4. by ArrowAssoc
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Scope()

    Permalink

Abstract Value Members

  1. abstract def interrupt(cause: Either[Throwable, Unit]): F[Unit]

    Permalink

    Interrupts evaluation of the current scope.

    Interrupts evaluation of the current scope. Only scopes previously indicated with Stream.interruptScope may be interrupted. For other scopes this will fail.

    Interruption is final and may take two forms:

    When invoked on right side, that will interrupt only current scope evaluation, and will resume when control is given to next scope.

    When invoked on left side, then this will inject given throwable like it will be caused by stream evaluation, and then, without any error handling the whole stream will fail with supplied throwable.

  2. abstract def lease: F[Option[Lease[F]]]

    Permalink

    Leases the resources of this scope until the returned lease is cancelled.

    Leases the resources of this scope until the returned lease is cancelled.

    Note that this leases all resources in this scope, resources in all parent scopes (up to root) and resources of all child scopes.

    None is returned if this scope is already closed. Otherwise a lease is returned, which must be cancelled. Upon cancellation, resource finalizers may be run, depending on the state of the owning scopes.

    Resources may be finalized during the execution of this method and before the lease has been acquired for a resource. In such an event, the already finalized resource won't be leased. As such, it is important to call lease only when all resources are known to be non-finalized / non-finalizing.

    When the lease is returned, all resources available at the time lease was called have been successfully leased.

Concrete Value Members

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

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def +(other: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Scope[F] to any2stringadd[Scope[F]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (Scope[F], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Scope[F] to ArrowAssoc[Scope[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  7. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  8. def ensuring(cond: (Scope[F]) ⇒ Boolean, msg: ⇒ Any): Scope[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Scope[F] to Ensuring[Scope[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  9. def ensuring(cond: (Scope[F]) ⇒ Boolean): Scope[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Scope[F] to Ensuring[Scope[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  10. def ensuring(cond: Boolean, msg: ⇒ Any): Scope[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Scope[F] to Ensuring[Scope[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  11. def ensuring(cond: Boolean): Scope[F]

    Permalink
    Implicit information
    This member is added by an implicit conversion from Scope[F] to Ensuring[Scope[F]] performed by method Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def formatted(fmtstr: String): String

    Permalink
    Implicit information
    This member is added by an implicit conversion from Scope[F] to StringFormat[Scope[F]] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  17. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  18. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  19. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  20. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  22. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  23. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  27. def [B](y: B): (Scope[F], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from Scope[F] to ArrowAssoc[Scope[F]] performed by method ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Scope[F] to any2stringadd[Scope[F]]

Inherited by implicit conversion StringFormat from Scope[F] to StringFormat[Scope[F]]

Inherited by implicit conversion Ensuring from Scope[F] to Ensuring[Scope[F]]

Inherited by implicit conversion ArrowAssoc from Scope[F] to ArrowAssoc[Scope[F]]

Ungrouped