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 higher 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. Syntax 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 Alternative extends Serializable
    Definition Classes
    cats
    Annotations
    @suppressUnusedImportWarningForScalaVersionSpecific()
  • AllOps
  • Ops
  • ToAlternativeOps
  • nonInheritedOps
  • ops

trait AllOps[F[_], A] extends Ops[F, A] with NonEmptyAlternative.AllOps[F, A] with MonoidK.AllOps[F, A]

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. AllOps
  2. AllOps
  3. Ops
  4. AllOps
  5. AllOps
  6. Ops
  7. AllOps
  8. AllOps
  9. Ops
  10. AllOps
  11. AllOps
  12. AllOps
  13. Ops
  14. Ops
  15. AllOps
  16. AllOps
  17. Ops
  18. Ops
  19. Ops
  20. Ops
  21. Ops
  22. Ops
  23. Serializable
  24. Serializable
  25. AnyRef
  26. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract type TypeClassType <: Alternative[F]
    Definition Classes
    AllOpsAllOpsOpsAllOpsOpsAllOpsAllOpsOpsAllOpsAllOpsOpsOpsAllOpsOpsOpsOpsOpsOpsOps

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 *>[B](fb: F[B]): F[B]
    Definition Classes
    Ops
    Annotations
    @inline()
  4. final def <*[B](fb: F[B]): F[A]
    Definition Classes
    Ops
    Annotations
    @inline()
  5. final def <*>[B, C](fa: F[B])(implicit arg0: <:<[A, (B) ⇒ C]): F[C]
    Definition Classes
    Ops
    Annotations
    @inline()
  6. def <+>(y: F[A]): F[A]
    Definition Classes
    Ops
  7. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def ap[B, C](fa: F[B])(implicit arg0: <:<[A, (B) ⇒ C]): F[C]
    Definition Classes
    Ops
  9. def ap2[B, C, D](fa: F[B], fb: F[C])(implicit arg0: <:<[A, (B, C) ⇒ D]): F[D]
    Definition Classes
    Ops
  10. def appendK(a: A): F[A]
    Definition Classes
    Ops
  11. def as[B](b: B): F[B]
    Definition Classes
    Ops
  12. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  14. def combineK(y: F[A]): F[A]
    Definition Classes
    Ops
  15. def combineKEval(y: Eval[F[A]]): Eval[F[A]]
    Definition Classes
    Ops
  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  18. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  19. final def fmap[B](f: (A) ⇒ B): F[B]
    Definition Classes
    Ops
  20. def fproduct[B](f: (A) ⇒ B): F[(A, B)]
    Definition Classes
    Ops
  21. def fproductLeft[B](f: (A) ⇒ B): F[(B, A)]
    Definition Classes
    Ops
  22. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  23. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  24. def imap[B](f: (A) ⇒ B)(g: (B) ⇒ A): F[B]
    Definition Classes
    Ops
  25. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  26. def map[B](f: (A) ⇒ B): F[B]
    Definition Classes
    Ops
  27. def map2[B, C](fb: F[B])(f: (A, B) ⇒ C): F[C]
    Definition Classes
    Ops
  28. def map2Eval[B, C](fb: Eval[F[B]])(f: (A, B) ⇒ C): Eval[F[C]]
    Definition Classes
    Ops
  29. def mapOrKeep[A1 >: A](pf: PartialFunction[A, A1]): F[A1]
    Definition Classes
    Ops
  30. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  31. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  32. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  33. def prependK(a: A): F[A]
    Definition Classes
    Ops
  34. def product[B](fb: F[B]): F[(A, B)]
    Definition Classes
    Ops
  35. def productL[B](fb: F[B]): F[A]
    Definition Classes
    Ops
  36. def productR[B](fb: F[B]): F[B]
    Definition Classes
    Ops
  37. def separate[G[_, _], B, C](implicit arg0: <:<[A, G[B, C]], FM: Monad[F], G: Bifoldable[G]): (F[B], F[C])
    Definition Classes
    Ops
  38. def separateFoldable[G[_, _], B, C](implicit arg0: <:<[A, G[B, C]], G: Bifoldable[G], FF: Foldable[F]): (F[B], F[C])
    Definition Classes
    Ops
  39. def sum[B](fb: F[B])(implicit F: Functor[F]): F[Either[A, B]]
    Definition Classes
    Ops
  40. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  41. def toString(): String
    Definition Classes
    AnyRef → Any
  42. def tupleLeft[B](b: B): F[(B, A)]
    Definition Classes
    Ops
  43. def tupleRight[B](b: B): F[(A, B)]
    Definition Classes
    Ops
  44. def unite[G[_], B](implicit arg0: <:<[A, G[B]], FM: Monad[F], G: Foldable[G]): F[B]
    Definition Classes
    Ops
  45. def void: F[Unit]
    Definition Classes
    Ops
  46. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  47. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  48. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  49. def widen[B >: A]: F[B]
    Definition Classes
    Ops

Inherited from MonoidK.AllOps[F, A]

Inherited from MonoidK.Ops[F, A]

Inherited from NonEmptyAlternative.AllOps[F, A]

Inherited from SemigroupK.AllOps[F, A]

Inherited from SemigroupK.Ops[F, A]

Inherited from Applicative.AllOps[F, A]

Inherited from InvariantMonoidal.AllOps[F, A]

Inherited from InvariantMonoidal.Ops[F, A]

Inherited from Apply.AllOps[F, A]

Inherited from InvariantSemigroupal.AllOps[F, A]

Inherited from Semigroupal.AllOps[F, A]

Inherited from Semigroupal.Ops[F, A]

Inherited from InvariantSemigroupal.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 Apply.Ops[F, A]

Inherited from Applicative.Ops[F, A]

Inherited from NonEmptyAlternative.Ops[F, A]

Inherited from Ops[F, A]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped