Trait

emblem.traversors.async

Traversor

Related Doc: package async

Permalink

trait Traversor extends AnyRef

asynchronously traverses a recursive data structure. the inputs and the outputs of the traversal are abstract here, and specified by the implementing class. this forms a generic pattern for visiting, generating, and transforming data.

you can traverse arbritrary data to your liking by implementing the protected vals and defs in this interface.

Source
Traversor.scala
Linear Supertypes
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Traversor
  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

Type Members

  1. trait CustomTraversor[A] extends AnyRef

    Permalink

    a custom traversor over type A

  2. type CustomTraversorPool = TypeKeyMap[Any, CustomTraversor]

    Permalink

    a TypeKeyMap for custom traversors

  3. type PropInput[A <: imports.HasEmblem, B] = (imports.EmblemProp[A, B], TraverseInput[B])

    Permalink

    an input for traversing an EmblemProp

    an input for traversing an EmblemProp

    Attributes
    protected
  4. type PropResult[A <: imports.HasEmblem, B] = (imports.EmblemProp[A, B], TraverseResult[B])

    Permalink

    an output for traversing an EmblemProp

    an output for traversing an EmblemProp

    Attributes
    protected
  5. abstract type TraverseInput[A]

    Permalink

    the input to a traversal step over type A

  6. abstract type TraverseResult[A]

    Permalink

    the output to a traversal step over type A

Abstract Value Members

  1. abstract def stageEmblemProps[A <: imports.HasEmblem](emblem: imports.Emblem[A], input: Future[TraverseInput[A]])(implicit arg0: imports.TypeKey[A]): Future[Iterable[PropInput[A, _]]]

    Permalink

    stages the traversal of a emblem's props

    stages the traversal of a emblem's props

    A

    the type of the HasEmblem object to traverse

    emblem

    the emblem being traversed

    input

    the input to the emblem traversal

    returns

    an iterable of inputs for the emblem props

    Attributes
    protected
  2. abstract def stageExtractor[Domain, Range](extractor: imports.Extractor[Domain, Range], input: Future[TraverseInput[Domain]])(implicit arg0: imports.TypeKey[Domain], arg1: imports.TypeKey[Range]): Future[TraverseInput[Range]]

    Permalink

    stages the traversal of a extractor

    stages the traversal of a extractor

    Domain

    the domain type for the extractor

    Range

    the range type for the extractor

    extractor

    the extractor being traversed

    input

    the input to the extractor traversal

    returns

    the input for traversing Extractor.inverse

    Attributes
    protected
  3. abstract def stageListElements[A](input: Future[TraverseInput[List[A]]])(implicit arg0: imports.TypeKey[A]): Future[Iterable[TraverseInput[A]]]

    Permalink

    stages the traversal of an list's elements

    stages the traversal of an list's elements

    A

    the type of the list elements

    input

    the input to traversing the list

    returns

    a iterable of inputs for the list's elements. an empty iterable is returned to avoid traversal into the list.

    Attributes
    protected
  4. abstract def stageOptionValue[A](input: Future[TraverseInput[Option[A]]])(implicit arg0: imports.TypeKey[A]): Future[Iterable[TraverseInput[A]]]

    Permalink

    stages the traversal of an option's value

    stages the traversal of an option's value

    A

    the type of the option's value

    input

    the input to traversing the option

    returns

    an iterable of 0 or 1 inputs of the option's value. an empty iterable is returned to avoid traversal into the option.

    Attributes
    protected
  5. abstract def stageSetElements[A](input: Future[TraverseInput[Set[A]]])(implicit arg0: imports.TypeKey[A]): Future[Iterable[TraverseInput[A]]]

    Permalink

    stages the traversal of a set's elements

    stages the traversal of a set's elements

    A

    the type of the set elements

    input

    the input to traversing the set

    returns

    a iterable of inputs for the set's elements. an empty iterable is returned to avoid traversal into the set.

    Attributes
    protected
  6. abstract def traverseBoolean(input: Future[TraverseInput[Boolean]]): Future[TraverseResult[Boolean]]

    Permalink

    traverses a boolean

    traverses a boolean

    Attributes
    protected
  7. abstract def traverseChar(input: Future[TraverseInput[Char]]): Future[TraverseResult[Char]]

    Permalink

    traverses a char

    traverses a char

    Attributes
    protected
  8. abstract def traverseDateTime(input: Future[TraverseInput[DateTime]]): Future[TraverseResult[DateTime]]

    Permalink

    traverses a date-time

    traverses a date-time

    Attributes
    protected
  9. abstract def traverseDouble(input: Future[TraverseInput[Double]]): Future[TraverseResult[Double]]

    Permalink

    traverses a double

    traverses a double

    Attributes
    protected
  10. abstract def traverseFloat(input: Future[TraverseInput[Float]]): Future[TraverseResult[Float]]

    Permalink

    traverses a float

    traverses a float

    Attributes
    protected
  11. abstract def traverseInt(input: Future[TraverseInput[Int]]): Future[TraverseResult[Int]]

    Permalink

    traverses an int

    traverses an int

    Attributes
    protected
  12. abstract def traverseLong(input: Future[TraverseInput[Long]]): Future[TraverseResult[Long]]

    Permalink

    traverses a long

    traverses a long

    Attributes
    protected
  13. abstract def traverseString(input: Future[TraverseInput[String]]): Future[TraverseResult[String]]

    Permalink

    traverses a string

    traverses a string

    Attributes
    protected
  14. abstract def unstageEmblemProps[A <: imports.HasEmblem](emblem: imports.Emblem[A], result: Future[Iterable[PropResult[A, _]]])(implicit arg0: imports.TypeKey[A]): Future[TraverseResult[A]]

    Permalink

    unstages the traversal of a emblem's props

    unstages the traversal of a emblem's props

    A

    the type of the HasEmblem object to traverse

    emblem

    the emblem being traversed

    result

    an iterable of the outputs for the emblem props

    returns

    the output for the emblem

    Attributes
    protected
  15. abstract def unstageExtractor[Domain, Range](extractor: imports.Extractor[Domain, Range], rangeResult: Future[TraverseResult[Range]])(implicit arg0: imports.TypeKey[Domain], arg1: imports.TypeKey[Range]): Future[TraverseResult[Domain]]

    Permalink

    unstages the traversal of a extractor

    unstages the traversal of a extractor

    Domain

    the domain type for the extractor

    Range

    the range type for the extractor

    extractor

    the extractor being traversed

    rangeResult

    the result of traversing Extractor.inverse

    returns

    the result of traversing the extractor

    Attributes
    protected
  16. abstract def unstageListElements[A](input: Future[TraverseInput[List[A]]], result: Future[Iterable[TraverseResult[A]]])(implicit arg0: imports.TypeKey[A]): Future[TraverseResult[List[A]]]

    Permalink

    unstages the traversal of a list's elements

    unstages the traversal of a list's elements

    A

    the type of the list elements

    input

    the input to traversing the list

    result

    an iterable of results for the list's elements. an empty iterable indicates that traversal into the list has been avoided

    returns

    the result of travering the list

    Attributes
    protected
  17. abstract def unstageOptionValue[A](input: Future[TraverseInput[Option[A]]], result: Future[Iterable[TraverseResult[A]]])(implicit arg0: imports.TypeKey[A]): Future[TraverseResult[Option[A]]]

    Permalink

    unstages the traversal of an option's value

    unstages the traversal of an option's value

    A

    the type of the option's value

    input

    the input to traversing the option

    result

    an iterable of 0 or 1 results of the option's value. an empty iterable indicates that traversal into the option has been avoided.

    returns

    the result of traversing the option

    Attributes
    protected
  18. abstract def unstageSetElements[A](input: Future[TraverseInput[Set[A]]], result: Future[Iterable[TraverseResult[A]]])(implicit arg0: imports.TypeKey[A]): Future[TraverseResult[Set[A]]]

    Permalink

    unstages the traversal of an set's elements

    unstages the traversal of an set's elements

    A

    the type of the set elements

    input

    the input to traversing the set

    result

    an iterable of results for the set's elements. an empty iterable indicates that traversal into the set has been avoided

    returns

    the result of travering the set

    Attributes
    protected

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  6. object CustomTraversorPool

    Permalink
  7. final def asInstanceOf[T0]: T0

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

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  9. val customTraversors: CustomTraversorPool

    Permalink

    the custom traversors to use in the recursive traversal

    the custom traversors to use in the recursive traversal

    Attributes
    protected
  10. val emblemPool: imports.EmblemPool

    Permalink

    the emblems to use in the recursive traversal

    the emblems to use in the recursive traversal

    Attributes
    protected
  11. def ensuring(cond: (Traversor) ⇒ Boolean, msg: ⇒ Any): Traversor

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  17. val extractorPool: imports.ExtractorPool

    Permalink

    the extractors to use in the recursive traversal

    the extractors to use in the recursive traversal

    Attributes
    protected
  18. def finalize(): Unit

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

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

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

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

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

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

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

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

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

    Permalink
    Definition Classes
    AnyRef → Any
  28. def traverse[A](input: Future[TraverseInput[A]])(implicit arg0: imports.TypeKey[A]): Future[TraverseResult[A]]

    Permalink

    traverses an object of any supported type.

    traverses an object of any supported type.

    A

    the type of the object to traverse

    input

    the asynchronous object to traverse

    returns

    the asynchronous result of the traversal. returns a failed future containing a emblem.exceptions.CouldNotTraverseException when an unsupported type is encountered during the traversal

  29. final def wait(): Unit

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

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

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. def [B](y: B): (Traversor, B)

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

Inherited from AnyRef

Inherited from Any

Inherited by implicit conversion any2stringadd from Traversor to any2stringadd[Traversor]

Inherited by implicit conversion StringFormat from Traversor to StringFormat[Traversor]

Inherited by implicit conversion Ensuring from Traversor to Ensuring[Traversor]

Inherited by implicit conversion ArrowAssoc from Traversor to ArrowAssoc[Traversor]

Ungrouped