io.dylemma.spac

Handler

trait Handler[-In, +Out] extends AnyRef

The base processing unit for pull-style streams processing.

A handler accepts inputs of type In, eventually yielding a value of type Out. If the handleInput or handleError methods for a handler ever return a Some, it implies that the handler has reached a result, and should no longer be called. Similarly, if the isFinished method returns true, the handleX methods should no longer be called.

Handlers are mutable by nature. Handler instances should not be shared across threads. Several traits in this library act as "blueprints" which create handler instances. These blueprint classes are immutable, and may be safely shared across threads.

In

The input type

Out

The output type

Source
Handler.scala
Linear Supertypes
AnyRef, Any
Known Subclasses
AbstractHandler, AbstractTakeWhileHandler, CollectHandler, CompoundHandler, ConsecutiveMatchSplitterHandler, ConstantHandler, ContextMiddlemanHandler, ContextSensitiveHandler, ContextStackSplitterHandler, DropNHandler, DropWhileHandler, EndWithErrorTransformerHandler, ExpectationSequenceHandler, FallbackSetHandler, FilteringHandler, FoldHandler, ForEachHandler, GetFirstHandler, GetFirstOptionHandler, InterrupterHandler, MappedConsumerHandler, MappedTransformerHandler, OneShotHandler, ParallelTransformerHandler, SafeConsumerHandler, ScanningHandler, SequencedInStackHandler, SideEffectHandler, SplitOnMatchHandler, TakeNHandler, TakeWhileHandler, ToListHandler, TransformerHandler, UnwrapSafeConsumerHandler, UnwrapSafeTransformerHandler, WrapSafeTransformerHandler
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Handler
  2. AnyRef
  3. Any
Implicitly
  1. by any2stringadd
  2. by any2stringfmt
  3. by any2ArrowAssoc
  4. by any2Ensuring
  1. Hide All
  2. Show all
Learn more about member selection
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def handleEnd(): Out

    Causes this handler to finalize and produce a result.

    Causes this handler to finalize and produce a result.

    This method should not be called if isFinished is already true.

    returns

    The final output of this parser

  2. abstract def handleError(error: Throwable): Option[Out]

    Causes this handler to process an error.

    Causes this handler to process an error.

    This method should not be called if isFinished == true

    error

    an error to be processed

    returns

    An option containing the final output if this handler became finished as a result of processing the error, or None if the handler is ready for more input.

  3. abstract def handleInput(input: In): Option[Out]

    Causes this handler to process an input element.

    Causes this handler to process an input element.

    This method should not be called if isFinished == true

    input

    an element to be processed

    returns

    An option containing the final output if this handler became finished as a result of processing the input, or None if the handler is ready for more input.

  4. abstract def isFinished: Boolean

    Tells if this handler is finished.

    Tells if this handler is finished.

    If a handler is finished, its handleX methods should no longer be called. Doing so after the handler finishes will cause undefined behavior. Typically a handler should be discarded once it is finished.

    returns

    whether this handler is finished

Concrete Value Members

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

    Definition Classes
    AnyRef

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

    Definition Classes
    Any

  3. final def ##(): Int

    Definition Classes
    AnyRef → Any

  4. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Handler[In, Out] to StringAdd performed by method any2stringadd in scala.Predef.
    Definition Classes
    StringAdd

  5. def ->[B](y: B): (Handler[In, Out], B)

    Implicit information
    This member is added by an implicit conversion from Handler[In, Out] to ArrowAssoc[Handler[In, Out]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc
    Annotations
    @inline()

  6. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef

  7. final def ==(arg0: Any): Boolean

    Definition Classes
    Any

  8. final def asInstanceOf[T0]: T0

    Definition Classes
    Any

  9. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. def ensuring(cond: (Handler[In, Out]) ⇒ Boolean, msg: ⇒ Any): Handler[In, Out]

    Implicit information
    This member is added by an implicit conversion from Handler[In, Out] to Ensuring[Handler[In, Out]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  11. def ensuring(cond: (Handler[In, Out]) ⇒ Boolean): Handler[In, Out]

    Implicit information
    This member is added by an implicit conversion from Handler[In, Out] to Ensuring[Handler[In, Out]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  12. def ensuring(cond: Boolean, msg: ⇒ Any): Handler[In, Out]

    Implicit information
    This member is added by an implicit conversion from Handler[In, Out] to Ensuring[Handler[In, Out]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

  13. def ensuring(cond: Boolean): Handler[In, Out]

    Implicit information
    This member is added by an implicit conversion from Handler[In, Out] to Ensuring[Handler[In, Out]] performed by method any2Ensuring in scala.Predef.
    Definition Classes
    Ensuring

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

    Definition Classes
    AnyRef

  15. def equals(arg0: Any): Boolean

    Definition Classes
    AnyRef → Any

  16. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  17. def formatted(fmtstr: String): String

    Implicit information
    This member is added by an implicit conversion from Handler[In, Out] to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()

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

    Definition Classes
    AnyRef → Any

  19. def hashCode(): Int

    Definition Classes
    AnyRef → Any

  20. final def isInstanceOf[T0]: Boolean

    Definition Classes
    Any

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

    Definition Classes
    AnyRef

  22. final def notify(): Unit

    Definition Classes
    AnyRef

  23. final def notifyAll(): Unit

    Definition Classes
    AnyRef

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

    Definition Classes
    AnyRef

  25. def toString(): String

    Definition Classes
    AnyRef → Any

  26. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

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

    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  29. def →[B](y: B): (Handler[In, Out], B)

    Implicit information
    This member is added by an implicit conversion from Handler[In, Out] to ArrowAssoc[Handler[In, Out]] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. val self: Any

    Implicit information
    This member is added by an implicit conversion from Handler[In, Out] to StringAdd performed by method any2stringadd in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (handler: StringAdd).self
    Definition Classes
    StringAdd

  2. val self: Any

    Implicit information
    This member is added by an implicit conversion from Handler[In, Out] to StringFormat performed by method any2stringfmt in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (handler: StringFormat).self
    Definition Classes
    StringFormat

Deprecated Value Members

  1. def x: Handler[In, Out]

    Implicit information
    This member is added by an implicit conversion from Handler[In, Out] to ArrowAssoc[Handler[In, Out]] performed by method any2ArrowAssoc in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (handler: ArrowAssoc[Handler[In, Out]]).x
    Definition Classes
    ArrowAssoc
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use leftOfArrow instead

  2. def x: Handler[In, Out]

    Implicit information
    This member is added by an implicit conversion from Handler[In, Out] to Ensuring[Handler[In, Out]] performed by method any2Ensuring in scala.Predef.
    Shadowing
    This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
    To access this member you can use a type ascription:
    (handler: Ensuring[Handler[In, Out]]).x
    Definition Classes
    Ensuring
    Annotations
    @deprecated
    Deprecated

    (Since version 2.10.0) Use resultOfEnsuring instead

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Handler[In, Out] to StringAdd

Inherited by implicit conversion any2stringfmt from Handler[In, Out] to StringFormat

Inherited by implicit conversion any2ArrowAssoc from Handler[In, Out] to ArrowAssoc[Handler[In, Out]]

Inherited by implicit conversion any2Ensuring from Handler[In, Out] to Ensuring[Handler[In, Out]]

Ungrouped