Class

io.dylemma.spac.syntax.ConsumerSyntax

ConsumerFollowedByOps

Related Doc: package ConsumerSyntax

Permalink

implicit class ConsumerFollowedByOps[In, T1] extends AnyRef

Implicitly adds followedBy and followedByStream to Consumers with Stackable input types. (Due to type variance conflicts between Consumer's In type and Stackable's type, these methods can't be defined directly on Consumer.)

In

The consumer's input type, which must be a member of the Stackable typeclass

T1

The consumer's output type

Source
ConsumerSyntax.scala
Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ConsumerFollowedByOps
  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 ConsumerFollowedByOps(consumer: Consumer[In, T1])(implicit arg0: Stackable[In])

    Permalink

    consumer

    The wrapped Consumer

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from ConsumerFollowedByOps[In, T1] to ArrowAssoc[ConsumerFollowedByOps[In, T1]] 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: (ConsumerFollowedByOps[In, T1]) ⇒ Boolean, msg: ⇒ Any): ConsumerFollowedByOps[In, T1]

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

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

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

    Permalink
    Implicit information
    This member is added by an implicit conversion from ConsumerFollowedByOps[In, T1] to Ensuring[ConsumerFollowedByOps[In, T1]] 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 followedBy: FollowedBy[[+T2]Consumer[In, T2], T1]

    Permalink

    An intermediate object with an apply and flatMap that both create a sequenced consumer which combines this consumer with a function to create the next one.

    An intermediate object with an apply and flatMap that both create a sequenced consumer which combines this consumer with a function to create the next one.

    Examples:

    val c1: Consumer[In, A] = /* ... */
    def getC2(c1Result: A): Consumer[In, B] = /* ... */
    val combined: Consumer[In, B] = c1.followedBy(getC2)
    
    // alternative `flatMap` syntax
    val combined: Consumer[In, B] = for {
      c1Result <- c1.followedBy
      c2Result <- getC2(c1Result)
    } yield c2Result

    An example of where this is useful is when a parser for XML element depends on values parsed from one of its previous siblings, but where you don't want to wait until the end of their parent element before they can be combined.

    returns

    An intermediate object which has an apply and flatMap that can be used to combine this Consumer and another in a sequence.

  16. def followedByStream: FollowedBy[[+T2]Transformer[In, T2], T1]

    Permalink

    An intermediate object with an apply and flatMap that can be used to create a Transformer from result of this consumer.

    An intermediate object with an apply and flatMap that can be used to create a Transformer from result of this consumer.

    Examples:

    val c1: Consumer[In, A] = /* ... */
    def getStream(c1Result: A): Transformer[In, B] = /* ... */
    val combined: Transformer[In, B] = c1.followedByStream(getStream)
    
    // alternative `flatMap` syntax
    val combined: Transformer[In, B] = for {
      c1Result <- c1.followedByStream
      c2Result <- getStream(c1Result)
    } yield c2Result

    An example of where this is useful is when an XML element contains some "dictionary" object at the beginning, followed by a sequence of "data" objects which reference the dictionary. For large sequences, combining them to a List (to use with Parser's and combiners) is undesireable; we can use this approach to avoid doing so.

    returns

    An intermediate object which has an apply and flatMap that can be used to combine this consumer and a Transformer in a sequence.

  17. def formatted(fmtstr: String): String

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  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. def [B](y: B): (ConsumerFollowedByOps[In, T1], B)

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from ConsumerFollowedByOps[In, T1] to any2stringadd[ConsumerFollowedByOps[In, T1]]

Inherited by implicit conversion StringFormat from ConsumerFollowedByOps[In, T1] to StringFormat[ConsumerFollowedByOps[In, T1]]

Inherited by implicit conversion Ensuring from ConsumerFollowedByOps[In, T1] to Ensuring[ConsumerFollowedByOps[In, T1]]

Inherited by implicit conversion ArrowAssoc from ConsumerFollowedByOps[In, T1] to ArrowAssoc[ConsumerFollowedByOps[In, T1]]

Ungrouped