cats-docs
2.11.0
API
Generated with
cats-docs/cats/cats.data

cats.data

package cats.data

Members list

Type members

Classlikes

sealed abstract class AndThen[-T, +R] extends T => R, Product, Serializable

A function type of a single input that can do function composition (via andThen and compose) in constant stack space with amortized linear time application (in the number of constituent functions).

A function type of a single input that can do function composition (via andThen and compose) in constant stack space with amortized linear time application (in the number of constituent functions).

Example:

val seed = AndThen((x: Int) => x + 1)
val f = (0 until 10000).foldLeft(seed)((acc, _) => acc.andThen(_ + 1))

// This should not trigger stack overflow ;-)
f(0)

This can be used to build stack safe data structures that make use of lambdas. The perfect candidates for usage with AndThen are the data structures using a signature like this (where F[_] is a monadic type):

A => F[B]

As an example, if we described this data structure, the naive solution for that map is stack unsafe:

case class Resource[F[_], A, B](
  acquire: F[A],
  use: A => F[B],
  release: A => F[Unit]) {

  def flatMap[C](f: B => C)(implicit F: Functor[F]): Resource[F, A, C] = {
    Resource(
      ra.acquire,
      // Stack Unsafe!
      a => ra.use(a).map(f),
      ra.release)
  }
}

To describe a flatMap operation for this data type, AndThen can save the day:

def flatMap[C](f: B => C)(implicit F: Functor[F]): Resource[F, A, C] = {
  Resource(
    ra.acquire,
    AndThen(ra.use).andThen(_.map(f)),
    ra.release)
}

Attributes

Companion
object
Source
AndThen.scala
Supertypes
trait Serializable
trait Product
trait Equals
trait T => R
class Object
trait Matchable
class Any
Show all
object AndThen

Attributes

Companion
class
Source
AndThen.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
AndThen.type
sealed abstract class AppFunc[F[_], A, B] extends Func[F, A, B]

An implementation of Func that's specialized to Applicative.

An implementation of Func that's specialized to Applicative.

Attributes

Companion
object
Source
Func.scala
Supertypes
class Func[F, A, B]
class Object
trait Matchable
class Any
Self type
AppFunc[F, A, B]
object AppFunc

Attributes

Companion
class
Source
Func.scala
Supertypes
class Object
trait Matchable
class Any
Self type
AppFunc.type
final case class Binested[F[_, _], G[_], H[_], A, B](value: F[G[A], H[B]])

Compose a two-slot type constructor F[_, _] with two single-slot type constructors G[_] and H[_], resulting in a two-slot type constructor with respect to the inner types.

Compose a two-slot type constructor F[_, _] with two single-slot type constructors G[_] and H[_], resulting in a two-slot type constructor with respect to the inner types. For example, List and Option both have Functor instances, and Either has a Bifunctor instance. Therefore, Binested[Either, List, Option, *, *] has a Bifunctor instance as well:

scala> import cats.Bifunctor
scala> import cats.data.Binested
scala> import cats.syntax.all._
scala> val eitherListOption: Either[List[Int], Option[String]] = Right(Some("cats"))
scala> val f: Int => String = _.toString
scala> val g: String => String = _ + "-bifunctor"
scala> val binested = Binested(eitherListOption)
scala> val bimapped = Bifunctor[Binested[Either, List, Option, *, *]].bimap(binested)(f, g).value
res0: Either[List[String], Option[String]] = Right(Some("cats-bifunctor"))

Attributes

Companion
object
Source
Binested.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Binested extends BinestedInstances

Attributes

Companion
class
Source
Binested.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Show all
Self type
Binested.type
sealed abstract class BinestedBifoldable[F[_, _], G[_], H[_]] extends Bifoldable[[_, _] =>> Binested[F, G, H, _$46, _$47]]

Attributes

Source
Binested.scala
Supertypes
trait Bifoldable[[_, _] =>> Binested[F, G, H, _$46, _$47]]
trait Serializable
class Object
trait Matchable
class Any
Known subtypes
class BinestedBitraverse[F, G, H]
sealed abstract class BinestedBitraverse[F[_, _], G[_], H[_]] extends BinestedBifoldable[F, G, H], Bitraverse[[_, _] =>> Binested[F, G, H, _$52, _$53]]

Attributes

Source
Binested.scala
Supertypes
trait Bitraverse[[_, _] =>> Binested[F, G, H, _$52, _$53]]
trait Bifunctor[[_, _] =>> Binested[F, G, H, _$52, _$53]]
class BinestedBifoldable[F, G, H]
trait Bifoldable[[_, _] =>> Binested[F, G, H, _$52, _$53]]
trait Serializable
class Object
trait Matchable
class Any
Show all
trait BinestedInstances

Attributes

Source
Binested.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Binested
sealed abstract class Chain[+A]

Trivial catenable sequence.

Trivial catenable sequence. Supports O(1) append, and (amortized) O(1) uncons, such that walking the sequence via N successive uncons steps takes O(N).

Attributes

Companion
object
Source
Chain.scala
Supertypes
class Object
trait Matchable
class Any
object Chain

Attributes

Companion
class
Source
Chain.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Chain.type
final case class Cokleisli[F[_], A, B](run: (F[A]) => B)

Represents a function F[A] => B.

Represents a function F[A] => B.

Attributes

Companion
object
Source
Cokleisli.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
Cokleisli[F, A, B]
object Cokleisli

Attributes

Companion
class
Source
Cokleisli.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Cokleisli.type
final case class Const[A, B](getConst: A)

Const is a phantom type, it does not contain a value of its second type parameter B Const can be seen as a type level version of Function.const[A, B]: A => B => A

Const is a phantom type, it does not contain a value of its second type parameter B Const can be seen as a type level version of Function.const[A, B]: A => B => A

Attributes

Companion
object
Source
Const.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Const

Attributes

Companion
class
Source
Const.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Const.type
object Cont

Attributes

Source
package.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Cont.type
sealed abstract class ContT[M[_], A, +B] extends Serializable

This is a continuation transformer based on the ContT in the Haskell package Control.Monad.Cont

This is a continuation transformer based on the ContT in the Haskell package Control.Monad.Cont

This is reasonably straight-forward except that to make a tailRecM implementation we leverage the Defer type class to obtain stack-safety.

Attributes

Companion
object
Source
ContT.scala
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object ContT

Attributes

Companion
class
Source
ContT.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
ContT.type
final case class EitherK[F[_], G[_], A](run: Either[F[A], G[A]])

F on the left and G on the right of scala.util.Either.

F on the left and G on the right of scala.util.Either.

Value parameters

run

The underlying scala.util.Either.

Attributes

Companion
object
Source
EitherK.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object EitherK

Attributes

Companion
class
Source
EitherK.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
EitherK.type
final case class EitherT[F[_], A, B](value: F[Either[A, B]])

Transformer for Either, allowing the effect of an arbitrary type constructor F to be combined with the fail-fast effect of Either.

Transformer for Either, allowing the effect of an arbitrary type constructor F to be combined with the fail-fast effect of Either.

EitherT[F, A, B] wraps a value of type F[Either[A, B]]. An F[C] can be lifted in to EitherT[F, A, C] via EitherT.right, and lifted in to a EitherT[F, C, B] via EitherT.left.

Attributes

Companion
object
Source
EitherT.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object EitherT

Attributes

Companion
class
Source
EitherT.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
EitherT.type
sealed abstract class Func[F[_], A, B]

Func is a function A => F[B].

Func is a function A => F[B].

See: The Essence of the Iterator Pattern

Attributes

Companion
object
Source
Func.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
class AppFunc[F, A, B]
Self type
Func[F, A, B]
object Func

Attributes

Companion
class
Source
Func.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Func.type
final case class IdT[F[_], A](value: F[A])

IdT[F[_], A] is the identity monad transformer.

IdT[F[_], A] is the identity monad transformer.

Attributes

Companion
object
Source
IdT.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object IdT

Attributes

Companion
class
Source
IdT.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
IdT.type
final class IndexedReaderWriterStateT[F[_], E, L, SA, SB, A](val runF: F[(E, SA) => F[(L, SB, A)]]) extends Serializable

Represents a stateful computation in a context F[_], from state SA to state SB, with an initial environment E, an accumulated log L and a result A.

Represents a stateful computation in a context F[_], from state SA to state SB, with an initial environment E, an accumulated log L and a result A.

In other words, it is a pre-baked stack of ReaderT[F, E, A], WriterT[F, L, A] and IndexedStateT[F, SA, SB, A].

Attributes

Companion
object
Source
IndexedReaderWriterStateT.scala
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object IndexedReaderWriterStateT

Attributes

Companion
class
Source
IndexedReaderWriterStateT.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object IndexedState

Attributes

Source
package.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final class IndexedStateT[F[_], SA, SB, A](val runF: F[SA => F[(SB, A)]]) extends Serializable

IndexedStateT[F, SA, SB, A] is a stateful computation in a context F yielding a value of type A.

IndexedStateT[F, SA, SB, A] is a stateful computation in a context F yielding a value of type A. The state transitions from a value of type SA to a value of type SB.

Note that for the SA != SB case, this is an indexed monad. Indexed monads are monadic type constructors annotated by an additional type for effect tracking purposes. In this case, the annotation tracks the initial state and the resulting state.

Given IndexedStateT[F, S, S, A], this yields the StateT[F, S, A] monad.

Attributes

Companion
object
Source
IndexedStateT.scala
Supertypes
trait Serializable
class Object
trait Matchable
class Any
object IndexedStateT

Attributes

Companion
class
Source
IndexedStateT.scala
Supertypes
class Object
trait Matchable
class Any
Self type
sealed abstract class Ior[+A, +B] extends Product, Serializable

Represents a right-biased disjunction that is either an A, or a B, or both an A and a B.

Represents a right-biased disjunction that is either an A, or a B, or both an A and a B.

An instance of A Ior B is one of: - Left[A] - Right[B] - Both[A, B]

A Ior B is similar to scala.util.Either[A, B], except that it can represent the simultaneous presence of an A and a B. It is right-biased so methods such as map and flatMap operate on the B value. Some methods, like flatMap, handle the presence of two Both values using a Semigroup[A], while other methods, like toEither, ignore the A value in a Both.

A Ior B is isomorphic to Either[Either[A, B], (A, B)], but provides methods biased toward B values, regardless of whether the B values appear in a Right or a Both. The isomorphic scala.util.Either form can be accessed via the unwrap method.

Attributes

Companion
object
Source
Ior.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Both[A, B]
class Left[A]
class Right[B]
object Ior

Attributes

Companion
class
Source
Ior.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Ior.type
final case class IorT[F[_], A, B](value: F[Ior[A, B]])

Attributes

Companion
object
Source
IorT.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object IorT

Attributes

Companion
class
Source
IorT.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
IorT.type
final case class Kleisli[F[_], -A, B](run: A => F[B])

Represents a function A => F[B].

Represents a function A => F[B].

Attributes

Companion
object
Source
Kleisli.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Self type
Kleisli[F, A, B]
object Kleisli

Attributes

Companion
class
Source
Kleisli.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Kleisli.type
final class KleisliFromFunctionPartiallyApplied[M[_], R]

Attributes

Source
Kleisli.scala
Supertypes
class Object
trait Matchable
class Any
final case class Nested[F[_], G[_], A](value: F[G[A]])

Similar to cats.data.Tuple2K, but for nested composition.

Similar to cats.data.Tuple2K, but for nested composition.

For instance, since both List and Option have a Functor, then so does List[Option[_]]. This is represented by this data type via the instantiation Nested[List, Option, *].

scala> import cats.Functor
scala> import cats.data.Nested
scala> import cats.syntax.all._
scala> val listOption: List[Option[Int]] = List(Some(1), None)
scala> val f: Int => String = i => (i * 2).toString
scala> Functor[List].map(listOption)(opt => opt.map(f))
res0: List[Option[String]] = List(Some(2), None)
scala> val nested: Nested[List, Option, Int] = Nested(listOption)
scala> val result: Nested[List, Option, String] = Functor[Nested[List, Option, *]].map(nested)(f)
scala> result.value
res1: List[Option[String]] = List(Some(2), None)

Attributes

Companion
object
Source
Nested.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Nested

Attributes

Companion
class
Source
Nested.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Nested.type
object NonEmptyChainImpl

Actual implementation for cats.data.NonEmptyChain

Actual implementation for cats.data.NonEmptyChain

Attributes

Note

This object is kept public for the sake of binary compatibility only and therefore is subject to changes in future versions of Cats. Do not use directly - use cats.data.NonEmptyChain instead.

Source
NonEmptyChain.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final class NonEmptyChainOps[A](value: Type[A]) extends AnyVal

Attributes

Source
NonEmptyChain.scala
Supertypes
class AnyVal
trait Matchable
class Any
object NonEmptyLazyList

Attributes

Source
NonEmptyLazyList.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final class NonEmptyLazyListOps[A](value: Type[A]) extends AnyVal

Attributes

Source
NonEmptyLazyList.scala
Supertypes
class AnyVal
trait Matchable
class Any
final case class NonEmptyList[+A](head: A, tail: List[A])

A data type which represents a non empty list of A, with single element (head) and optional structure (tail).

A data type which represents a non empty list of A, with single element (head) and optional structure (tail).

Attributes

Companion
object
Source
NonEmptyList.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object NonEmptyList

Attributes

Companion
class
Source
NonEmptyList.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
object NonEmptyMapImpl

Actual implementation for cats.data.NonEmptyMap

Actual implementation for cats.data.NonEmptyMap

Attributes

Note

This object is kept public for the sake of binary compatibility only and therefore is subject to changes in future versions of Cats. Do not use directly - use cats.data.NonEmptyMap instead.

Source
NonEmptyMapImpl.scala
Supertypes
class Object
trait Matchable
class Any
Self type
sealed class NonEmptyMapOps[K, A](val value: Type[K, A])

Attributes

Source
NonEmptyMapImpl.scala
Supertypes
class Object
trait Matchable
class Any
final class NonEmptySeq[+A] extends AnyVal

A data type which represents a Seq guaranteed to contain at least one element.

A data type which represents a Seq guaranteed to contain at least one element.
Note that the constructor is private to prevent accidental construction of an empty NonEmptySeq. However, due to https://issues.scala-lang.org/browse/SI-6601, on Scala 2.10, this may be bypassed due to a compiler bug.

Attributes

Companion
object
Source
NonEmptySeq.scala
Supertypes
class AnyVal
trait Matchable
class Any
object NonEmptySeq extends Serializable

Attributes

Companion
class
Source
NonEmptySeq.scala
Supertypes
trait Serializable
class Object
trait Matchable
class Any
Self type
object NonEmptySetImpl

Actual implementation for cats.data.NonEmptySet

Actual implementation for cats.data.NonEmptySet

Attributes

Note

This object is kept public for the sake of binary compatibility only and therefore is subject to changes in future versions of Cats. Do not use directly - use cats.data.NonEmptySet instead.

Source
NonEmptySet.scala
Supertypes
class Object
trait Matchable
class Any
Self type
sealed class NonEmptySetOps[A](val value: Type[A])

Attributes

Source
NonEmptySet.scala
Supertypes
class Object
trait Matchable
class Any
final class NonEmptyVector[+A] extends AnyVal

A data type which represents a Vector guaranteed to contain at least one element.

A data type which represents a Vector guaranteed to contain at least one element.
Note that the constructor is private to prevent accidental construction of an empty NonEmptyVector. However, due to https://issues.scala-lang.org/browse/SI-6601, on Scala 2.10, this may be bypassed due to a compiler bug.

Attributes

Companion
object
Source
NonEmptyVector.scala
Supertypes
class AnyVal
trait Matchable
class Any
object NonEmptyVector extends Serializable

Attributes

Companion
class
Source
NonEmptyVector.scala
Supertypes
trait Serializable
class Object
trait Matchable
class Any
Self type
final case class OneAnd[F[_], A](head: A, tail: F[A])

A data type which represents a single element (head) and some other structure (tail).

A data type which represents a single element (head) and some other structure (tail). As we have done in package.scala, this can be used to represent a Stream which is guaranteed to not be empty:

type NonEmptyStream[A] = OneAnd[Stream, A]

Attributes

Companion
object
Source
OneAnd.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object OneAnd

Attributes

Companion
class
Source
OneAnd.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
OneAnd.type
final case class Op[Arr[_, _], A, B](run: Arr[B, A])

The dual category of some other category, Arr.

The dual category of some other category, Arr.

Attributes

Companion
object
Source
Op.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Op

Attributes

Companion
class
Source
Op.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Op.type
final case class OptionT[F[_], A](value: F[Option[A]])

OptionT[F[_], A] is a light wrapper on an F[Option[A]] with some convenient methods for working with this nested structure.

OptionT[F[_], A] is a light wrapper on an F[Option[A]] with some convenient methods for working with this nested structure.

It may also be said that OptionT is a monad transformer for Option.

For more information, see the documentation.

Attributes

Companion
object
Source
OptionT.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object OptionT

Attributes

Companion
class
Source
OptionT.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
OptionT.type
object Reader

Attributes

Source
package.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Reader.type
object ReaderWriterState

Attributes

Source
package.scala
Supertypes
class Object
trait Matchable
class Any
Self type
object ReaderWriterStateT

Attributes

Source
package.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final case class RepresentableStore[F[_], S, A](fa: F[A], index: S)(implicit R: Aux[F, S])

A generalization of StoreT, where the underlying functor F has a Representable instance.

A generalization of StoreT, where the underlying functor F has a Representable instance. Store is the dual of State

Attributes

Companion
object
Source
RepresentableStore.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RepresentableStore

Attributes

Companion
class
Source
RepresentableStore.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final case class RepresentableStoreT[W[_], F[_], S, A](runF: W[F[A]], index: S)(implicit F: Aux[F, S])

Attributes

Companion
object
Source
RepresentableStoreT.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object RepresentableStoreT extends RepresentableStoreTInstances1

Attributes

Companion
class
Source
RepresentableStoreT.scala
Supertypes
class Object
trait Matchable
class Any
Self type
trait RepresentableStoreTInstances1 extends RepresentableStoreTInstances2

Attributes

Source
RepresentableStoreT.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait RepresentableStoreTInstances2

Attributes

Source
RepresentableStoreT.scala
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object State

Attributes

Source
package.scala
Supertypes
class Object
trait Matchable
class Any
Self type
State.type
object StateT

Attributes

Source
package.scala
Supertypes
class Object
trait Matchable
class Any
Self type
StateT.type
object Store

Attributes

Source
package.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Store.type
object StoreT

Attributes

Source
package.scala
Supertypes
class Object
trait Matchable
class Any
Self type
StoreT.type
final case class Tuple2K[F[_], G[_], A](first: F[A], second: G[A])

Tuple2K is a product to two independent functor values.

Tuple2K is a product to two independent functor values.

See: The Essence of the Iterator Pattern

Attributes

Companion
object
Source
Tuple2K.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Tuple2K

Attributes

Companion
class
Source
Tuple2K.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Tuple2K.type
sealed abstract class Validated[+E, +A] extends Product, Serializable

Attributes

Companion
object
Source
Validated.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Invalid[E]
class Valid[A]
object Validated

Attributes

Companion
class
Source
Validated.scala
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Validated.type
object Writer

Attributes

Source
package.scala
Supertypes
class Object
trait Matchable
class Any
Self type
Writer.type
final case class WriterT[F[_], L, V](run: F[(L, V)])

Attributes

Companion
object
Source
WriterT.scala
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object WriterT

Attributes

Companion
class
Source
WriterT.scala
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
WriterT.type
final class ZipLazyList[A](val value: LazyList[A]) extends AnyVal

Attributes

Companion
object
Source
ZipLazyList.scala
Supertypes
class AnyVal
trait Matchable
class Any
object ZipLazyList

Attributes

Companion
class
Source
ZipLazyList.scala
Supertypes
class Object
trait Matchable
class Any
Self type
final class ZipList[A](val value: List[A]) extends AnyVal

Attributes

Companion
object
Source
ZipList.scala
Supertypes
class AnyVal
trait Matchable
class Any
object ZipList

Attributes

Companion
class
Source
ZipList.scala
Supertypes
class Object
trait Matchable
class Any
Self type
ZipList.type
final class ZipSeq[A](val value: Seq[A]) extends AnyVal

Attributes

Companion
object
Source
ZipSeq.scala
Supertypes
class AnyVal
trait Matchable
class Any
object ZipSeq

Attributes

Companion
class
Source
ZipSeq.scala
Supertypes
class Object
trait Matchable
class Any
Self type
ZipSeq.type
final class ZipVector[A](val value: Vector[A]) extends AnyVal

Attributes

Companion
object
Source
ZipVector.scala
Supertypes
class AnyVal
trait Matchable
class Any
object ZipVector

Attributes

Companion
class
Source
ZipVector.scala
Supertypes
class Object
trait Matchable
class Any
Self type
ZipVector.type

Deprecated classlikes

final class ZipStream[A](val value: Stream[A]) extends AnyVal

Attributes

Companion
object
Deprecated
true
Source
ZipStream.scala
Supertypes
class AnyVal
trait Matchable
class Any
object ZipStream

Attributes

Companion
class
Deprecated
true
Source
ZipStream.scala
Supertypes
class Object
trait Matchable
class Any
Self type
ZipStream.type

Types

type Cont[A, B] = ContT[Eval, A, B]

Attributes

Source
package.scala
type EitherNec[+E, +A] = Either[Type[E], A]

Attributes

Source
package.scala
type EitherNel[+E, +A] = Either[NonEmptyList[E], A]

Attributes

Source
package.scala
type EitherNes[E, +A] = Either[Type[E], A]

Attributes

Source
package.scala
type IRWST[F[_], E, L, SA, SB, A] = IndexedReaderWriterStateT[F, E, L, SA, SB, A]

Attributes

Source
package.scala
type IndexedState[S1, S2, A] = IndexedStateT[Eval, S1, S2, A]

Attributes

Source
package.scala
type IorNec[+B, +A] = Ior[Type[B], A]

Attributes

Source
package.scala
type IorNel[+B, +A] = Ior[NonEmptyList[B], A]

Attributes

Source
package.scala
type IorNes[B, +A] = Ior[Type[B], A]

Attributes

Source
package.scala
type NonEmptyChain[+A] = Type[A]

Attributes

Source
package.scala
type NonEmptyMap[K, +A] = Type[K, A]

Attributes

Source
package.scala
type NonEmptySet[A] = Type[A]

Attributes

Source
package.scala
type RWS[E, L, S, A] = ReaderWriterState[E, L, S, A]

Attributes

Source
package.scala
type RWST[F[_], E, L, S, A] = ReaderWriterStateT[F, E, L, S, A]

Attributes

Source
package.scala
type Reader[-A, B] = Kleisli[Id, A, B]

Attributes

Source
package.scala
type ReaderT[F[_], -A, B] = Kleisli[F, A, B]

Attributes

Source
package.scala
type ReaderWriterState[E, L, S, A] = ReaderWriterStateT[Eval, E, L, S, A]

Attributes

Source
package.scala
type ReaderWriterStateT[F[_], E, L, S, A] = IndexedReaderWriterStateT[F, E, L, S, S, A]

Represents a stateful computation in a context F[_], over state S, with an initial environment E, an accumulated log L and a result A.

Represents a stateful computation in a context F[_], over state S, with an initial environment E, an accumulated log L and a result A.

Attributes

Source
package.scala
type State[S, A] = StateT[Eval, S, A]

Attributes

Source
package.scala
type StateT[F[_], S, A] = IndexedStateT[F, S, S, A]

StateT[F, S, A] is similar to Kleisli[F, S, A] in that it takes an S argument and produces an A value wrapped in F.

StateT[F, S, A] is similar to Kleisli[F, S, A] in that it takes an S argument and produces an A value wrapped in F. However, it also produces an S value representing the updated state (which is wrapped in the F context along with the A value.

Attributes

Source
package.scala
type Store[S, A] = RepresentableStore[[_] =>> S => _$6, S, A]

Attributes

Source
package.scala
type StoreT[W[_], S, A] = RepresentableStoreT[W, [_] =>> S => _$9, S, A]

Attributes

Source
package.scala
type ValidatedNec[+E, +A] = Validated[Type[E], A]

Attributes

Source
package.scala
type ValidatedNel[+E, +A] = Validated[NonEmptyList[E], A]

Attributes

Source
package.scala
type Writer[L, V] = WriterT[Id, L, V]

Attributes

Source
package.scala

Inherited types

Deprecated and Inherited types

type NonEmptyStream[A] = OneAnd[Stream, A]

Attributes

Deprecated
true
Inherited from:
ScalaVersionSpecificPackage (hidden)
Source
ScalaVersionSpecificPackage.scala

Value members

Deprecated and Inherited methods

def NonEmptyStream[A](head: A, tail: A*): NonEmptyStream[A]

Attributes

Deprecated
true
Inherited from:
ScalaVersionSpecificPackage (hidden)
Source
ScalaVersionSpecificPackage.scala
def NonEmptyStream[A](head: A, tail: Stream[A]): NonEmptyStream[A]

Attributes

Deprecated
true
Inherited from:
ScalaVersionSpecificPackage (hidden)
Source
ScalaVersionSpecificPackage.scala

Concrete fields

val IRWST: IndexedReaderWriterStateT.type

Attributes

Source
package.scala
val NonEmptyChain: NonEmptyChainImpl.type

Attributes

Source
package.scala
val NonEmptyMap: NonEmptyMapImpl.type

Attributes

Source
package.scala
val NonEmptySet: NonEmptySetImpl.type

Attributes

Source
package.scala
val RWS: ReaderWriterState.type

Attributes

Source
package.scala
val RWST: ReaderWriterStateT.type

Attributes

Source
package.scala
val ReaderT: Kleisli.type

Attributes

Source
package.scala
Generated with