Class

fs2.Stream

StepLeg

Related Doc: package Stream

Permalink

final class StepLeg[F[_], O] extends AnyRef

When merging multiple streams, this represents step of one leg.

It is common to uncons, however unlike uncons, it keeps track of stream scope independently of the main scope of the stream.

This assures, that after each next stepLeg each Stream leg keeps its scope when interpreting.

Usual scenarios is to first invoke stream.pull.stepLeg and then consume whatever is available in leg.head. If the next step is required leg.stepLeg will yield next Leg.

Once the stream will stop to be interleaved (merged), then stream allows to return to normal stream invocation.

Self Type
StepLeg[F, O]
Source
Stream.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. StepLeg
  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 StepLeg(head: Chunk[O], scopeId: Token, next: FreeC[[γ$27$]Algebra[F, O, γ$27$], Unit])

    Permalink

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 StepLeg[F, O] to any2stringadd[StepLeg[F, O]] performed by method any2stringadd in scala.Predef.
    Definition Classes
    any2stringadd
  4. def ->[B](y: B): (StepLeg[F, O], B)

    Permalink
    Implicit information
    This member is added by an implicit conversion from StepLeg[F, O] to ArrowAssoc[StepLeg[F, O]] 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
    @HotSpotIntrinsicCandidate() @throws( ... )
  8. def ensuring(cond: (StepLeg[F, O]) ⇒ Boolean, msg: ⇒ Any): StepLeg[F, O]

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from StepLeg[F, O] to Ensuring[StepLeg[F, O]] 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 formatted(fmtstr: String): String

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

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  16. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
    Annotations
    @HotSpotIntrinsicCandidate()
  17. val head: Chunk[O]

    Permalink
  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
    Annotations
    @HotSpotIntrinsicCandidate()
  21. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @HotSpotIntrinsicCandidate()
  22. def setHead(nextHead: Chunk[O]): StepLeg[F, O]

    Permalink

    Replaces head of this leg.

    Replaces head of this leg. Useful when the head was not fully consumed.

  23. def stepLeg: Pull[F, INothing, Option[StepLeg[F, O]]]

    Permalink

    Provides an uncons-like operation on this leg of the stream.

  24. def stream: Stream[F, O]

    Permalink

    Converts this leg back to regular stream.

    Converts this leg back to regular stream. Scope is updated to the scope associated with this leg. Note that when this is invoked, no more interleaving legs are allowed, and this must be very last leg remaining.

    Note that resulting stream won't contain the head of this leg.

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  27. final def wait(arg0: Long, arg1: Int): Unit

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  30. def [B](y: B): (StepLeg[F, O], B)

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

Deprecated Value Members

  1. def finalize(): Unit

    Permalink
    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 AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from StepLeg[F, O] to any2stringadd[StepLeg[F, O]]

Inherited by implicit conversion StringFormat from StepLeg[F, O] to StringFormat[StepLeg[F, O]]

Inherited by implicit conversion Ensuring from StepLeg[F, O] to Ensuring[StepLeg[F, O]]

Inherited by implicit conversion ArrowAssoc from StepLeg[F, O] to ArrowAssoc[StepLeg[F, O]]

Ungrouped