Packages

trait SingletonTraverse[F[_]] extends Traverse[F]

cats.Traverse for containers with at most one element.

Self Type
SingletonTraverse[F]
Linear Supertypes
Traverse[F], UnorderedTraverse[F], Foldable[F], FoldableNFunctions[F], UnorderedFoldable[F], Functor[F], Invariant[F], Serializable, AnyRef, Any
Known Subclasses
FromTraverse
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SingletonTraverse
  2. Traverse
  3. UnorderedTraverse
  4. Foldable
  5. FoldableNFunctions
  6. UnorderedFoldable
  7. Functor
  8. Invariant
  9. Serializable
  10. AnyRef
  11. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. abstract type Context

    The type for actual context of the element.

    The type for actual context of the element. For example, for F[A] = Either[String, (Int, A)], the Context should be Int. This gives better type information than considering the general context type Either[String, *] because Either[String, *] could also be a scala.Left$ and thus not contain an Int at all.

Abstract Value Members

  1. abstract def foldLeft[A, B](fa: F[A], b: B)(f: (B, A) => B): B
    Definition Classes
    Foldable
  2. abstract def foldRight[A, B](fa: F[A], lb: Eval[B])(f: (A, Eval[B]) => Eval[B]): Eval[B]
    Definition Classes
    Foldable
  3. abstract def traverse[G[_], A, B](fa: F[A])(f: (A) => G[B])(implicit arg0: Applicative[G]): G[F[B]]
    Definition Classes
    Traverse
  4. abstract def traverseSingleton[G[_], A, B](x: F[A])(f: (Context, A) => G[B])(implicit G: Applicative[G]): G[F[B]]

    Threads the effect G of the given function f through this container.

    Threads the effect G of the given function f through this container. Also passes the context of this container (i.e., the container structure) to the function.

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. def as[A, B](fa: F[A], b: B): F[B]
    Definition Classes
    Functor
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. def collectFirst[A, B](fa: F[A])(pf: PartialFunction[A, B]): Option[B]
    Definition Classes
    Foldable
  8. def collectFirstSome[A, B](fa: F[A])(f: (A) => Option[B]): Option[B]
    Definition Classes
    Foldable
  9. def collectFirstSomeM[G[_], A, B](fa: F[A])(f: (A) => G[Option[B]])(implicit G: Monad[G]): G[Option[B]]
    Definition Classes
    Foldable
  10. def collectFold[A, B](fa: F[A])(f: PartialFunction[A, B])(implicit B: Monoid[B]): B
    Definition Classes
    Foldable
  11. def collectFoldSome[A, B](fa: F[A])(f: (A) => Option[B])(implicit B: Monoid[B]): B
    Definition Classes
    Foldable
  12. def combineAll[A](fa: F[A])(implicit arg0: Monoid[A]): A
    Definition Classes
    Foldable
  13. def combineAllOption[A](fa: F[A])(implicit ev: Semigroup[A]): Option[A]
    Definition Classes
    Foldable
  14. def compose[G[_]](implicit arg0: Traverse[G]): Traverse[[α]F[G[α]]]
    Definition Classes
    Traverse
  15. def compose[G[_]](implicit arg0: Foldable[G]): Foldable[[α]F[G[α]]]
    Definition Classes
    Foldable
  16. def compose[G[_]](implicit arg0: Functor[G]): Functor[[α]F[G[α]]]
    Definition Classes
    Functor
  17. def compose[G[_]](implicit arg0: Invariant[G]): Invariant[[α]F[G[α]]]
    Definition Classes
    Invariant
  18. def composeBifunctor[G[_, _]](implicit arg0: Bifunctor[G]): Bifunctor[[α, β]F[G[α, β]]]
    Definition Classes
    Functor
  19. def composeContravariant[G[_]](implicit arg0: Contravariant[G]): Contravariant[[α]F[G[α]]]
    Definition Classes
    Functor → Invariant
  20. def composeFunctor[G[_]](implicit arg0: Functor[G]): Invariant[[α]F[G[α]]]
    Definition Classes
    Invariant
  21. def composeWith[G[_]](G: SingletonTraverse[G]): ComposeSingletonTraversePartiallyApplied[F, G, Context, Context]

    Composes this type class instance with another type class instance.

    Composes this type class instance with another type class instance.

    Apply the result to a combination function for the contexts of the two type class instances. This allows to throw away the context of one instance, e.g., if it does not contain any information like in the case of Option or Either. The default org.apache.pekko.stream.scaladsl.Keep.both retains both contexts.

  22. def contains_[A](fa: F[A], v: A)(implicit ev: Eq[A]): Boolean
    Definition Classes
    UnorderedFoldable
  23. def count[A](fa: F[A])(p: (A) => Boolean): Long
    Definition Classes
    UnorderedFoldable
  24. def dropWhile_[A](fa: F[A])(p: (A) => Boolean): List[A]
    Definition Classes
    Foldable
  25. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  26. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  27. def exists[A](fa: F[A])(p: (A) => Boolean): Boolean
    Definition Classes
    Foldable → UnorderedFoldable
  28. def existsM[G[_], A](fa: F[A])(p: (A) => G[Boolean])(implicit G: Monad[G]): G[Boolean]
    Definition Classes
    Foldable
  29. def filter_[A](fa: F[A])(p: (A) => Boolean): List[A]
    Definition Classes
    Foldable
  30. def find[A](fa: F[A])(f: (A) => Boolean): Option[A]
    Definition Classes
    Foldable
  31. def findM[G[_], A](fa: F[A])(p: (A) => G[Boolean])(implicit G: Monad[G]): G[Option[A]]
    Definition Classes
    Foldable
  32. def flatSequence[G[_], A](fgfa: F[G[F[A]]])(implicit G: Applicative[G], F: FlatMap[F]): G[F[A]]
    Definition Classes
    Traverse
  33. def flatTraverse[G[_], A, B](fa: F[A])(f: (A) => G[F[B]])(implicit G: Applicative[G], F: FlatMap[F]): G[F[B]]
    Definition Classes
    Traverse
  34. final def fmap[A, B](fa: F[A])(f: (A) => B): F[B]
    Definition Classes
    Functor
  35. def fold[A](fa: F[A])(implicit A: Monoid[A]): A
    Definition Classes
    Foldable
  36. def foldA[G[_], A](fga: F[G[A]])(implicit G: Applicative[G], A: Monoid[A]): G[A]
    Definition Classes
    Foldable
  37. def foldK[G[_], A](fga: F[G[A]])(implicit G: MonoidK[G]): G[A]
    Definition Classes
    Foldable
  38. final def foldLeftM[G[_], A, B](fa: F[A], z: B)(f: (B, A) => G[B])(implicit G: Monad[G]): G[B]
    Definition Classes
    Foldable
  39. def foldM[G[_], A, B](fa: F[A], z: B)(f: (B, A) => G[B])(implicit G: Monad[G]): G[B]
    Definition Classes
    Foldable
  40. def foldMap[A, B](fa: F[A])(f: (A) => B)(implicit B: Monoid[B]): B
    Definition Classes
    Foldable
  41. def foldMapA[G[_], A, B](fa: F[A])(f: (A) => G[B])(implicit G: Applicative[G], B: Monoid[B]): G[B]
    Definition Classes
    Foldable
  42. def foldMapK[G[_], A, B](fa: F[A])(f: (A) => G[B])(implicit G: MonoidK[G]): G[B]
    Definition Classes
    Foldable
  43. def foldMapM[G[_], A, B](fa: F[A])(f: (A) => G[B])(implicit G: Monad[G], B: Monoid[B]): G[B]
    Definition Classes
    Foldable
  44. def foldRightDefer[G[_], A, B](fa: F[A], gb: G[B])(fn: (A, G[B]) => G[B])(implicit arg0: Defer[G]): G[B]
    Definition Classes
    Foldable
  45. def forall[A](fa: F[A])(p: (A) => Boolean): Boolean
    Definition Classes
    Foldable → UnorderedFoldable
  46. def forallM[G[_], A](fa: F[A])(p: (A) => G[Boolean])(implicit G: Monad[G]): G[Boolean]
    Definition Classes
    Foldable
  47. def fproduct[A, B](fa: F[A])(f: (A) => B): F[(A, B)]
    Definition Classes
    Functor
  48. def fproductLeft[A, B](fa: F[A])(f: (A) => B): F[(B, A)]
    Definition Classes
    Functor
  49. def get[A](fa: F[A])(idx: Long): Option[A]
    Definition Classes
    Foldable
  50. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  51. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  52. def ifF[A](fb: F[Boolean])(ifTrue: => A, ifFalse: => A): F[A]
    Definition Classes
    Functor
  53. def imap[A, B](fa: F[A])(f: (A) => B)(g: (B) => A): F[B]
    Definition Classes
    Functor → Invariant
  54. def intercalate[A](fa: F[A], a: A)(implicit A: Monoid[A]): A
    Definition Classes
    Foldable
  55. def intersperseList[A](xs: List[A], x: A): List[A]
    Attributes
    protected
    Definition Classes
    Foldable
  56. def isEmpty[A](fa: F[A]): Boolean
    Definition Classes
    Foldable → UnorderedFoldable
  57. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  58. def lift[A, B](f: (A) => B): (F[A]) => F[B]
    Definition Classes
    Functor
  59. def map[A, B](fa: F[A])(f: (A) => B): F[B]
    Definition Classes
    Traverse → Functor
  60. def mapAccumulate[S, A, B](init: S, fa: F[A])(f: (S, A) => (S, B)): (S, F[B])
    Definition Classes
    Traverse
  61. def mapOrKeep[A, A1 >: A](fa: F[A])(pf: PartialFunction[A, A1]): F[A1]
    Definition Classes
    Functor
  62. def mapWithIndex[A, B](fa: F[A])(f: (A, Int) => B): F[B]
    Definition Classes
    Traverse
  63. def mapWithLongIndex[A, B](fa: F[A])(f: (A, Long) => B): F[B]
    Definition Classes
    Traverse
  64. def maximumByList[A, B](fa: F[A])(f: (A) => B)(implicit arg0: Order[B]): List[A]
    Definition Classes
    Foldable
  65. def maximumByOption[A, B](fa: F[A])(f: (A) => B)(implicit arg0: Order[B]): Option[A]
    Definition Classes
    Foldable
  66. def maximumList[A](fa: F[A])(implicit A: Order[A]): List[A]
    Definition Classes
    Foldable
  67. def maximumOption[A](fa: F[A])(implicit A: Order[A]): Option[A]
    Definition Classes
    Foldable
  68. def minimumByList[A, B](fa: F[A])(f: (A) => B)(implicit arg0: Order[B]): List[A]
    Definition Classes
    Foldable
  69. def minimumByOption[A, B](fa: F[A])(f: (A) => B)(implicit arg0: Order[B]): Option[A]
    Definition Classes
    Foldable
  70. def minimumList[A](fa: F[A])(implicit A: Order[A]): List[A]
    Definition Classes
    Foldable
  71. def minimumOption[A](fa: F[A])(implicit A: Order[A]): Option[A]
    Definition Classes
    Foldable
  72. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  73. def nonEmpty[A](fa: F[A]): Boolean
    Definition Classes
    Foldable → UnorderedFoldable
  74. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  75. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  76. def partitionBifold[H[_, _], A, B, C](fa: F[A])(f: (A) => H[B, C])(implicit A: Alternative[F], H: Bifoldable[H]): (F[B], F[C])
    Definition Classes
    Foldable
  77. def partitionBifoldM[G[_], H[_, _], A, B, C](fa: F[A])(f: (A) => G[H[B, C]])(implicit A: Alternative[F], M: Monad[G], H: Bifoldable[H]): G[(F[B], F[C])]
    Definition Classes
    Foldable
  78. def partitionEither[A, B, C](fa: F[A])(f: (A) => Either[B, C])(implicit A: Alternative[F]): (F[B], F[C])
    Definition Classes
    Foldable
  79. def partitionEitherM[G[_], A, B, C](fa: F[A])(f: (A) => G[Either[B, C]])(implicit A: Alternative[F], M: Monad[G]): G[(F[B], F[C])]
    Definition Classes
    Foldable
  80. def productAll[A](fa: F[A])(implicit A: Numeric[A]): A
    Definition Classes
    Foldable
  81. def reduceLeftOption[A](fa: F[A])(f: (A, A) => A): Option[A]
    Definition Classes
    Foldable
  82. def reduceLeftToOption[A, B](fa: F[A])(f: (A) => B)(g: (B, A) => B): Option[B]
    Definition Classes
    Foldable
  83. def reduceRightOption[A](fa: F[A])(f: (A, Eval[A]) => Eval[A]): Eval[Option[A]]
    Definition Classes
    Foldable
  84. def reduceRightToOption[A, B](fa: F[A])(f: (A) => B)(g: (A, Eval[B]) => Eval[B]): Eval[Option[B]]
    Definition Classes
    Foldable
  85. def sequence[G[_], A](fga: F[G[A]])(implicit arg0: Applicative[G]): G[F[A]]
    Definition Classes
    Traverse
  86. def sequence_[G[_], A](fga: F[G[A]])(implicit arg0: Applicative[G]): G[Unit]
    Definition Classes
    Foldable
  87. def size[A](fa: F[A]): Long
    Definition Classes
    UnorderedFoldable
  88. def sliding10[A](fa: F[A]): List[(A, A, A, A, A, A, A, A, A, A)]
    Definition Classes
    FoldableNFunctions
  89. def sliding11[A](fa: F[A]): List[(A, A, A, A, A, A, A, A, A, A, A)]
    Definition Classes
    FoldableNFunctions
  90. def sliding12[A](fa: F[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A)]
    Definition Classes
    FoldableNFunctions
  91. def sliding13[A](fa: F[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A, A)]
    Definition Classes
    FoldableNFunctions
  92. def sliding14[A](fa: F[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A, A, A)]
    Definition Classes
    FoldableNFunctions
  93. def sliding15[A](fa: F[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A, A, A, A)]
    Definition Classes
    FoldableNFunctions
  94. def sliding16[A](fa: F[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A)]
    Definition Classes
    FoldableNFunctions
  95. def sliding17[A](fa: F[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A)]
    Definition Classes
    FoldableNFunctions
  96. def sliding18[A](fa: F[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A)]
    Definition Classes
    FoldableNFunctions
  97. def sliding19[A](fa: F[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A)]
    Definition Classes
    FoldableNFunctions
  98. def sliding2[A](fa: F[A]): List[(A, A)]
    Definition Classes
    FoldableNFunctions
  99. def sliding20[A](fa: F[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A)]
    Definition Classes
    FoldableNFunctions
  100. def sliding21[A](fa: F[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A)]
    Definition Classes
    FoldableNFunctions
  101. def sliding22[A](fa: F[A]): List[(A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A, A)]
    Definition Classes
    FoldableNFunctions
  102. def sliding3[A](fa: F[A]): List[(A, A, A)]
    Definition Classes
    FoldableNFunctions
  103. def sliding4[A](fa: F[A]): List[(A, A, A, A)]
    Definition Classes
    FoldableNFunctions
  104. def sliding5[A](fa: F[A]): List[(A, A, A, A, A)]
    Definition Classes
    FoldableNFunctions
  105. def sliding6[A](fa: F[A]): List[(A, A, A, A, A, A)]
    Definition Classes
    FoldableNFunctions
  106. def sliding7[A](fa: F[A]): List[(A, A, A, A, A, A, A)]
    Definition Classes
    FoldableNFunctions
  107. def sliding8[A](fa: F[A]): List[(A, A, A, A, A, A, A, A)]
    Definition Classes
    FoldableNFunctions
  108. def sliding9[A](fa: F[A]): List[(A, A, A, A, A, A, A, A, A)]
    Definition Classes
    FoldableNFunctions
  109. def sumAll[A](fa: F[A])(implicit A: Numeric[A]): A
    Definition Classes
    Foldable
  110. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  111. def takeWhile_[A](fa: F[A])(p: (A) => Boolean): List[A]
    Definition Classes
    Foldable
  112. def toIterable[A](fa: F[A]): Iterable[A]
    Definition Classes
    Foldable
  113. def toList[A](fa: F[A]): List[A]
    Definition Classes
    Foldable
  114. def toString(): String
    Definition Classes
    AnyRef → Any
  115. def traverseTap[G[_], A, B](fa: F[A])(f: (A) => G[B])(implicit arg0: Applicative[G]): G[F[A]]
    Definition Classes
    Traverse
  116. def traverseWithIndexM[G[_], A, B](fa: F[A])(f: (A, Int) => G[B])(implicit G: Monad[G]): G[F[B]]
    Definition Classes
    Traverse
  117. def traverseWithLongIndexM[G[_], A, B](fa: F[A])(f: (A, Long) => G[B])(implicit G: Monad[G]): G[F[B]]
    Definition Classes
    Traverse
  118. def traverse_[G[_], A, B](fa: F[A])(f: (A) => G[B])(implicit G: Applicative[G]): G[Unit]
    Definition Classes
    Foldable
  119. def tupleLeft[A, B](fa: F[A], b: B): F[(B, A)]
    Definition Classes
    Functor
  120. def tupleRight[A, B](fa: F[A], b: B): F[(A, B)]
    Definition Classes
    Functor
  121. def unorderedFold[A](fa: F[A])(implicit arg0: CommutativeMonoid[A]): A
    Definition Classes
    Foldable → UnorderedFoldable
  122. def unorderedFoldMap[A, B](fa: F[A])(f: (A) => B)(implicit arg0: CommutativeMonoid[B]): B
    Definition Classes
    Foldable → UnorderedFoldable
  123. def unorderedSequence[G[_], A](fga: F[G[A]])(implicit arg0: CommutativeApplicative[G]): G[F[A]]
    Definition Classes
    Traverse → UnorderedTraverse
  124. def unorderedTraverse[G[_], A, B](sa: F[A])(f: (A) => G[B])(implicit arg0: CommutativeApplicative[G]): G[F[B]]
    Definition Classes
    Traverse → UnorderedTraverse
  125. def unzip[A, B](fab: F[(A, B)]): (F[A], F[B])
    Definition Classes
    Functor
  126. def updated_[A, B >: A](fa: F[A], idx: Long, b: B): Option[F[B]]
    Definition Classes
    Traverse
  127. def void[A](fa: F[A]): F[Unit]
    Definition Classes
    Functor
  128. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  129. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  130. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  131. def widen[A, B >: A](fa: F[A]): F[B]
    Definition Classes
    Functor
  132. def zipWithIndex[A](fa: F[A]): F[(A, Int)]
    Definition Classes
    Traverse
  133. def zipWithLongIndex[A](fa: F[A]): F[(A, Long)]
    Definition Classes
    Traverse

Deprecated Value Members

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

    (Since version 9)

Inherited from Traverse[F]

Inherited from UnorderedTraverse[F]

Inherited from Foldable[F]

Inherited from FoldableNFunctions[F]

Inherited from UnorderedFoldable[F]

Inherited from Functor[F]

Inherited from Invariant[F]

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped