Packages

  • package root
    Definition Classes
    root
  • package cats

    The cats root package contains all the trait signatures of most Scala type classes.

    The cats root package contains all the trait signatures of most Scala type classes.

    Cats type classes are implemented using the approach from the Type classes as objects and implicits article.

    For each type class, cats provides three pieces: - Its signature: a trait that is polymorphic on a type parameter. Type class traits inherit from other type classes to indicate that any implementation of the lower type class (e.g. Applicative) can also serve as an instance for the higuer type class (e.g. Functor). - Type class 'instances, which are classes and objects that implement one or more type class signatures for some specific types. Type class instances for several data types from the Java or Scala standard libraries are declared in the subpackage cats.instances. - Syntax extensions, each of which provides the methods of the type class defines as extension methods (which in Scala 2 are encoded as implicit classes) for values of any type F; given that an instance of the type class for the receiver type (this) is in the implicit scope. Symtax extensions are declared in the cats.syntax package. - A set of laws, that are also generic on the type of the class, and are only defined on the operations of the type class. The purpose of these laws is to declare some algebraic relations (equations) between Scala expressions involving the operations of the type class, and test (but not verify) that implemented instances satisfy those equations. Laws are defined in the cats-laws package.

    Although most of cats type classes are declared in this package, some are declared in other packages: - type classes that operate on base types (kind *), and their implementations for standard library types, are contained in cats.kernel, which is a different SBT project. However, they are re-exported from this package. - type classes of kind F[_, _], such as cats.arrow.Profunctor" or cats.arrow.Arrow, which are relevant for Functional Reactive Programming or optics, are declared in the cats.arrow package. - Also, those type classes that abstract over (pure or impure) functional runtime effects are declared in the cats-effect library. - Some type classes for which no laws can be provided are left out of the main road, in a small and dirty alley. These are the alleycats.

    Definition Classes
    root
  • object Traverse extends Serializable
    Definition Classes
    cats
  • AllOps
  • Ops
  • ToTraverseOps
  • nonInheritedOps
  • ops

trait AllOps[F[_], A] extends Ops[F, A] with Functor.AllOps[F, A] with Foldable.AllOps[F, A] with UnorderedTraverse.AllOps[F, A]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AllOps
  2. AllOps
  3. Ops
  4. AllOps
  5. AllOps
  6. Ops
  7. Ops
  8. AllOps
  9. AllOps
  10. Ops
  11. Ops
  12. Ops
  13. Serializable
  14. Serializable
  15. AnyRef
  16. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type TypeClassType <: Traverse[F]
    Definition Classes
    AllOpsAllOpsOpsAllOpsOpsOpsAllOpsOpsOpsOps

Abstract Value Members

  1. abstract def self: F[A]
    Definition Classes
    Ops
  2. abstract val typeClassInstance: TypeClassType
    Definition Classes
    Ops

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[B](b: B): F[B]
    Definition Classes
    Ops
  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  7. def collectFirst[B](pf: PartialFunction[A, B]): Option[B]
    Definition Classes
    Ops
  8. def collectFirstSome[B](f: (A) ⇒ Option[B]): Option[B]
    Definition Classes
    Ops
  9. def collectFoldSome[B](f: (A) ⇒ Option[B])(implicit B: Monoid[B]): B
    Definition Classes
    Ops
  10. def combineAll(implicit arg0: Monoid[A]): A
    Definition Classes
    Ops
  11. def combineAllOption(implicit ev: Semigroup[A]): Option[A]
    Definition Classes
    Ops
  12. def dropWhile_(p: (A) ⇒ Boolean): List[A]
    Definition Classes
    Ops
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  15. def exists(p: (A) ⇒ Boolean): Boolean
    Definition Classes
    Ops
  16. def existsM[G[_]](p: (A) ⇒ G[Boolean])(implicit G: Monad[G]): G[Boolean]
    Definition Classes
    Ops
  17. def filter_(p: (A) ⇒ Boolean): List[A]
    Definition Classes
    Ops
  18. def find(f: (A) ⇒ Boolean): Option[A]
    Definition Classes
    Ops
  19. def flatSequence[G[_], B](implicit arg0: <:<[A, G[F[B]]], G: Applicative[G], F: FlatMap[F]): G[F[B]]
    Definition Classes
    Ops
  20. def flatTraverse[G[_], B](f: (A) ⇒ G[F[B]])(implicit G: Applicative[G], F: FlatMap[F]): G[F[B]]
    Definition Classes
    Ops
  21. final def fmap[B](f: (A) ⇒ B): F[B]
    Definition Classes
    Ops
  22. def fold(implicit A: Monoid[A]): A
    Definition Classes
    Ops
  23. def foldK[G[_], B](implicit arg0: <:<[A, G[B]], G: MonoidK[G]): G[B]
    Definition Classes
    Ops
  24. def foldLeft[B](b: B)(f: (B, A) ⇒ B): B
    Definition Classes
    Ops
  25. final def foldLeftM[G[_], B](z: B)(f: (B, A) ⇒ G[B])(implicit G: Monad[G]): G[B]
    Definition Classes
    Ops
  26. def foldM[G[_], B](z: B)(f: (B, A) ⇒ G[B])(implicit G: Monad[G]): G[B]
    Definition Classes
    Ops
  27. def foldMap[B](f: (A) ⇒ B)(implicit B: Monoid[B]): B
    Definition Classes
    Ops
  28. def foldMapA[G[_], B](f: (A) ⇒ G[B])(implicit G: Applicative[G], B: Monoid[B]): G[B]
    Definition Classes
    Ops
  29. def foldMapM[G[_], B](f: (A) ⇒ G[B])(implicit G: Monad[G], B: Monoid[B]): G[B]
    Definition Classes
    Ops
  30. def foldRight[B](lb: Eval[B])(f: (A, Eval[B]) ⇒ Eval[B]): Eval[B]
    Definition Classes
    Ops
  31. def foldRightDefer[G[_], B](gb: G[B])(fn: (A, G[B]) ⇒ G[B])(implicit arg0: Defer[G]): G[B]
    Definition Classes
    Ops
  32. def forall(p: (A) ⇒ Boolean): Boolean
    Definition Classes
    Ops
  33. def forallM[G[_]](p: (A) ⇒ G[Boolean])(implicit G: Monad[G]): G[Boolean]
    Definition Classes
    Ops
  34. def fproduct[B](f: (A) ⇒ B): F[(A, B)]
    Definition Classes
    Ops
  35. def fproductLeft[B](f: (A) ⇒ B): F[(B, A)]
    Definition Classes
    Ops
  36. def get(idx: Long): Option[A]
    Definition Classes
    Ops
  37. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  38. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  39. def imap[B](f: (A) ⇒ B)(g: (B) ⇒ A): F[B]
    Definition Classes
    Ops
  40. def intercalate(a: A)(implicit A: Monoid[A]): A
    Definition Classes
    Ops
  41. def isEmpty: Boolean
    Definition Classes
    Ops
  42. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  43. def map[B](f: (A) ⇒ B): F[B]
    Definition Classes
    Ops
  44. def mapWithIndex[B](f: (A, Int) ⇒ B): F[B]
    Definition Classes
    Ops
  45. def maximumByList[B](f: (A) ⇒ B)(implicit arg0: Order[B]): List[A]
    Definition Classes
    Ops
  46. def maximumByOption[B](f: (A) ⇒ B)(implicit arg0: Order[B]): Option[A]
    Definition Classes
    Ops
  47. def maximumList(implicit A: Order[A]): List[A]
    Definition Classes
    Ops
  48. def maximumOption(implicit A: Order[A]): Option[A]
    Definition Classes
    Ops
  49. def minimumByList[B](f: (A) ⇒ B)(implicit arg0: Order[B]): List[A]
    Definition Classes
    Ops
  50. def minimumByOption[B](f: (A) ⇒ B)(implicit arg0: Order[B]): Option[A]
    Definition Classes
    Ops
  51. def minimumList(implicit A: Order[A]): List[A]
    Definition Classes
    Ops
  52. def minimumOption(implicit A: Order[A]): Option[A]
    Definition Classes
    Ops
  53. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  54. def nonEmpty: Boolean
    Definition Classes
    Ops
  55. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  56. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  57. def partitionEither[B, C](f: (A) ⇒ Either[B, C])(implicit A: Alternative[F]): (F[B], F[C])
    Definition Classes
    Ops
  58. def productAll(implicit A: Numeric[A]): A
    Definition Classes
    Ops
  59. def reduceLeftOption(f: (A, A) ⇒ A): Option[A]
    Definition Classes
    Ops
  60. def reduceLeftToOption[B](f: (A) ⇒ B)(g: (B, A) ⇒ B): Option[B]
    Definition Classes
    Ops
  61. def reduceRightOption(f: (A, Eval[A]) ⇒ Eval[A]): Eval[Option[A]]
    Definition Classes
    Ops
  62. def reduceRightToOption[B](f: (A) ⇒ B)(g: (A, Eval[B]) ⇒ Eval[B]): Eval[Option[B]]
    Definition Classes
    Ops
  63. def sequence[G[_], B](implicit arg0: <:<[A, G[B]], arg1: Applicative[G]): G[F[B]]
    Definition Classes
    Ops
  64. def sequence_[G[_], B](implicit arg0: <:<[A, G[B]], arg1: Applicative[G]): G[Unit]
    Definition Classes
    Ops
  65. def size: Long
    Definition Classes
    Ops
  66. def sumAll(implicit A: Numeric[A]): A
    Definition Classes
    Ops
  67. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  68. def takeWhile_(p: (A) ⇒ Boolean): List[A]
    Definition Classes
    Ops
  69. def toIterable: Iterable[A]
    Definition Classes
    Ops
  70. def toList: List[A]
    Definition Classes
    Ops
  71. def toString(): String
    Definition Classes
    AnyRef → Any
  72. def traverse[G[_], B](f: (A) ⇒ G[B])(implicit arg0: Applicative[G]): G[F[B]]
    Definition Classes
    Ops
  73. def traverseTap[G[_], B](f: (A) ⇒ G[B])(implicit arg0: Applicative[G]): G[F[A]]
    Definition Classes
    Ops
  74. def traverseWithIndexM[G[_], B](f: (A, Int) ⇒ G[B])(implicit G: Monad[G]): G[F[B]]
    Definition Classes
    Ops
  75. def traverse_[G[_], B](f: (A) ⇒ G[B])(implicit G: Applicative[G]): G[Unit]
    Definition Classes
    Ops
  76. def tupleLeft[B](b: B): F[(B, A)]
    Definition Classes
    Ops
  77. def tupleRight[B](b: B): F[(A, B)]
    Definition Classes
    Ops
  78. def unorderedFold(implicit arg0: CommutativeMonoid[A]): A
    Definition Classes
    Ops
  79. def unorderedFoldMap[B](f: (A) ⇒ B)(implicit arg0: CommutativeMonoid[B]): B
    Definition Classes
    Ops
  80. def unorderedSequence[G[_], B](implicit arg0: <:<[A, G[B]], arg1: CommutativeApplicative[G]): G[F[B]]
    Definition Classes
    Ops
  81. def unorderedTraverse[G[_], B](f: (A) ⇒ G[B])(implicit arg0: CommutativeApplicative[G]): G[F[B]]
    Definition Classes
    Ops
  82. def void: F[Unit]
    Definition Classes
    Ops
  83. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  84. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  85. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  86. def widen[B >: A]: F[B]
    Definition Classes
    Ops
  87. def zipWithIndex: F[(A, Int)]
    Definition Classes
    Ops

Deprecated Value Members

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

Inherited from UnorderedTraverse.AllOps[F, A]

Inherited from UnorderedTraverse.Ops[F, A]

Inherited from Foldable.AllOps[F, A]

Inherited from UnorderedFoldable.AllOps[F, A]

Inherited from UnorderedFoldable.Ops[F, A]

Inherited from Foldable.Ops[F, A]

Inherited from Functor.AllOps[F, A]

Inherited from Invariant.AllOps[F, A]

Inherited from Invariant.Ops[F, A]

Inherited from Functor.Ops[F, A]

Inherited from Ops[F, A]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped