Packages

trait CharLikeChunks[F[_], In] extends AnyRef

A typeclass witnessing that a stream of type In has chunks that can be iterated over to get characters.

Annotations
@implicitNotFound()
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. CharLikeChunks
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type Context

    The context used to pull chunks and iterate over characters.

    The context used to pull chunks and iterate over characters. Implementations might decide to have immutable or mutable contexts depending on performance constraints that are desired.

Abstract Value Members

  1. abstract def advance(ctx: Context): Context

    Advances one character in the context.

    Advances one character in the context. This method is called for stepping through characters, so it is preferrable to have it efficient. Implemetations can be based on mutable Context, as a new one is created locally by the parsers.

    This should not perform any effect or pull.

    Implementations can assume that needsPull will be called after this step function to check boundaries within the current chunk in the context.

  2. abstract def create(s: Stream[F, In]): Context

    Creates a context out of a stream.

  3. abstract def current(ctx: Context): Char

    Returns the current character in the context.

    Returns the current character in the context.

    Implementations can assume this will never fail, as parsers will check for needsPull and pullNext before calling this function.

    This should not perform any effect or pull and must be pure.

  4. abstract def needsPull(ctx: Context): Boolean

    Decides whether a new chunk must be pulled from the context.

  5. abstract def pullNext(ctx: Context): Pull[F, INothing, Option[Context]]

    Pulls the next chunk from the context.

    Pulls the next chunk from the context. Returns None if stream is exhausted.

Concrete 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. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  10. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  11. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  13. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  14. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  15. def toString(): String
    Definition Classes
    AnyRef → Any
  16. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  17. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  18. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

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

Inherited from AnyRef

Inherited from Any

Ungrouped