ToggleMonad

trait Monad[Toggle]
trait Apply[Toggle]
trait Serializable
class Object
trait Matchable
class Any

Value members

Concrete methods

override def pure[A](x: A): Toggle[A]
Definition Classes

Inherited methods

@inline
final def *>[A, B](fa: Toggle[A])(fb: Toggle[B]): Toggle[B]

Alias for productR.

Alias for productR.

Inherited from:
Apply
@inline
final def <*[A, B](fa: Toggle[A])(fb: Toggle[B]): Toggle[A]

Alias for productL.

Alias for productL.

Inherited from:
Apply
@inline
final def <*>[A, B](ff: Toggle[A => B])(fa: Toggle[A]): Toggle[B]

Alias for ap.

Alias for ap.

Inherited from:
Apply
override def ap[A, B](ff: Toggle[A => B])(fa: Toggle[A]): Toggle[B]
Definition Classes
Inherited from:
FlatMap
def ap10[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, Z](f: Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9) => Z])(f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9]): Toggle[Z]
Inherited from:
ApplyArityFunctions
def ap11[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, Z](f: Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10) => Z])(f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10]): Toggle[Z]
Inherited from:
ApplyArityFunctions
def ap12[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, Z](f: Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11) => Z])(f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11]): Toggle[Z]
Inherited from:
ApplyArityFunctions
def ap13[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, Z](f: Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12) => Z])(f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12]): Toggle[Z]
Inherited from:
ApplyArityFunctions
def ap14[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, Z](f: Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13) => Z])(f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13]): Toggle[Z]
Inherited from:
ApplyArityFunctions
def ap15[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, Z](f: Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14) => Z])(f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14]): Toggle[Z]
Inherited from:
ApplyArityFunctions
def ap16[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, Z](f: Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15) => Z])(f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15]): Toggle[Z]
Inherited from:
ApplyArityFunctions
def ap17[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, Z](f: Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16) => Z])(f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15], f16: Toggle[A16]): Toggle[Z]
Inherited from:
ApplyArityFunctions
def ap18[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, Z](f: Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17) => Z])(f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15], f16: Toggle[A16], f17: Toggle[A17]): Toggle[Z]
Inherited from:
ApplyArityFunctions
def ap19[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, Z](f: Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18) => Z])(f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15], f16: Toggle[A16], f17: Toggle[A17], f18: Toggle[A18]): Toggle[Z]
Inherited from:
ApplyArityFunctions
override def ap2[A, B, Z](ff: Toggle[(A, B) => Z])(fa: Toggle[A], fb: Toggle[B]): Toggle[Z]
Definition Classes
Inherited from:
FlatMap
def ap20[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, Z](f: Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19) => Z])(f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15], f16: Toggle[A16], f17: Toggle[A17], f18: Toggle[A18], f19: Toggle[A19]): Toggle[Z]
Inherited from:
ApplyArityFunctions
def ap21[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, Z](f: Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20) => Z])(f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15], f16: Toggle[A16], f17: Toggle[A17], f18: Toggle[A18], f19: Toggle[A19], f20: Toggle[A20]): Toggle[Z]
Inherited from:
ApplyArityFunctions
def ap22[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, Z](f: Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21) => Z])(f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15], f16: Toggle[A16], f17: Toggle[A17], f18: Toggle[A18], f19: Toggle[A19], f20: Toggle[A20], f21: Toggle[A21]): Toggle[Z]
Inherited from:
ApplyArityFunctions
def ap3[A0, A1, A2, Z](f: Toggle[(A0, A1, A2) => Z])(f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2]): Toggle[Z]
Inherited from:
ApplyArityFunctions
def ap4[A0, A1, A2, A3, Z](f: Toggle[(A0, A1, A2, A3) => Z])(f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3]): Toggle[Z]
Inherited from:
ApplyArityFunctions
def ap5[A0, A1, A2, A3, A4, Z](f: Toggle[(A0, A1, A2, A3, A4) => Z])(f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4]): Toggle[Z]
Inherited from:
ApplyArityFunctions
def ap6[A0, A1, A2, A3, A4, A5, Z](f: Toggle[(A0, A1, A2, A3, A4, A5) => Z])(f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5]): Toggle[Z]
Inherited from:
ApplyArityFunctions
def ap7[A0, A1, A2, A3, A4, A5, A6, Z](f: Toggle[(A0, A1, A2, A3, A4, A5, A6) => Z])(f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6]): Toggle[Z]
Inherited from:
ApplyArityFunctions
def ap8[A0, A1, A2, A3, A4, A5, A6, A7, Z](f: Toggle[(A0, A1, A2, A3, A4, A5, A6, A7) => Z])(f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7]): Toggle[Z]
Inherited from:
ApplyArityFunctions
def ap9[A0, A1, A2, A3, A4, A5, A6, A7, A8, Z](f: Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8) => Z])(f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8]): Toggle[Z]
Inherited from:
ApplyArityFunctions
def as[A, B](fa: Toggle[A], b: B): Toggle[B]

Replaces the A value in F[A] with the supplied value.

Replaces the A value in F[A] with the supplied value.

Example:

scala> import cats.Functor
scala> import cats.implicits.catsStdInstancesForList

scala> Functor[List].as(List(1,2,3), "hello")
res0: List[String] = List(hello, hello, hello)
Inherited from:
Functor
def compose[G[_] : Applicative]: Applicative[[α] =>> Toggle[G[α]]]

Compose an Applicative[F] and an Applicative[G] into an Applicative[λ[α => F[G[α]]]].

Compose an Applicative[F] and an Applicative[G] into an Applicative[λ[α => F[G[α]]]].

Example:

scala> import cats.implicits._

scala> val alo = Applicative[List].compose[Option]

scala> alo.pure(3)
res0: List[Option[Int]] = List(Some(3))

scala> alo.product(List(None, Some(true), Some(false)), List(Some(2), None))
res1: List[Option[(Boolean, Int)]] = List(None, None, Some((true,2)), None, Some((false,2)), None)
Inherited from:
Applicative
def compose[G[_] : Invariant]: Invariant[[α] =>> Toggle[G[α]]]

Compose Invariant F[_] and G[_] then produce Invariant[F[G[_]]] using their imap.

Compose Invariant F[_] and G[_] then produce Invariant[F[G[_]]] using their imap.

Example:

scala> import cats.implicits._
scala> import scala.concurrent.duration._

scala> val durSemigroupList: Semigroup[List[FiniteDuration]] =
    | Invariant[Semigroup].compose[List].imap(Semigroup[List[Long]])(Duration.fromNanos)(_.toNanos)
scala> durSemigroupList.combine(List(2.seconds, 3.seconds), List(4.seconds))
res1: List[FiniteDuration] = List(2 seconds, 3 seconds, 4 seconds)
Inherited from:
Invariant
def compose[G[_] : Apply]: Apply[[α] =>> Toggle[G[α]]]

Compose an Apply[F] and an Apply[G] into an Apply[λ[α => F[G[α]]]].

Compose an Apply[F] and an Apply[G] into an Apply[λ[α => F[G[α]]]].

Example:

scala> import cats.implicits._

scala> val alo = Apply[List].compose[Option]

scala> alo.product(List(None, Some(true), Some(false)), List(Some(2), None))
res1: List[Option[(Boolean, Int)]] = List(None, None, Some((true,2)), None, Some((false,2)), None)
Inherited from:
Apply
def compose[G[_] : Functor]: Functor[[α] =>> Toggle[G[α]]]
Inherited from:
Functor
def composeApply[G[_] : Apply]: InvariantSemigroupal[[α] =>> Toggle[G[α]]]
Inherited from:
InvariantSemigroupal
override def composeContravariant[G[_] : Contravariant]: Contravariant[[α] =>> Toggle[G[α]]]
Definition Classes
Inherited from:
Functor

Compose an Applicative[F] and a ContravariantMonoidal[G] into a ContravariantMonoidal[λ[α => F[G[α]]]].

Compose an Applicative[F] and a ContravariantMonoidal[G] into a ContravariantMonoidal[λ[α => F[G[α]]]].

Example:

scala> import cats.kernel.Comparison
scala> import cats.implicits._

// compares strings by alphabetical order
scala> val alpha: Order[String] = Order[String]

// compares strings by their length
scala> val strLength: Order[String] = Order.by[String, Int](_.length)

scala> val stringOrders: List[Order[String]] = List(alpha, strLength)

// first comparison is with alpha order, second is with string length
scala> stringOrders.map(o => o.comparison("abc", "de"))
res0: List[Comparison] = List(LessThan, GreaterThan)

scala> val le = Applicative[List].composeContravariantMonoidal[Order]

// create Int orders that convert ints to strings and then use the string orders
scala> val intOrders: List[Order[Int]] = le.contramap(stringOrders)(_.toString)

// first comparison is with alpha order, second is with string length
scala> intOrders.map(o => o.comparison(12, 3))
res1: List[Comparison] = List(LessThan, GreaterThan)

// create the `product` of the string order list and the int order list
// `p` contains a list of the following orders:
// 1. (alpha comparison on strings followed by alpha comparison on ints)
// 2. (alpha comparison on strings followed by length comparison on ints)
// 3. (length comparison on strings followed by alpha comparison on ints)
// 4. (length comparison on strings followed by length comparison on ints)
scala> val p: List[Order[(String, Int)]] = le.product(stringOrders, intOrders)

scala> p.map(o => o.comparison(("abc", 12), ("def", 3)))
res2: List[Comparison] = List(LessThan, LessThan, LessThan, GreaterThan)
Inherited from:
Applicative
def composeFunctor[G[_] : Functor]: Invariant[[α] =>> Toggle[G[α]]]

Compose Invariant F[_] and Functor G[_] then produce Invariant[F[G[_]]] using F's imap and G's map.

Compose Invariant F[_] and Functor G[_] then produce Invariant[F[G[_]]] using F's imap and G's map.

Example:

scala> import cats.implicits._
scala> import scala.concurrent.duration._

scala> val durSemigroupList: Semigroup[List[FiniteDuration]] =
    | Invariant[Semigroup]
    |   .composeFunctor[List]
    |   .imap(Semigroup[List[Long]])(Duration.fromNanos)(_.toNanos)
scala> durSemigroupList.combine(List(2.seconds, 3.seconds), List(4.seconds))
res1: List[FiniteDuration] = List(2 seconds, 3 seconds, 4 seconds)
Inherited from:
Invariant
override def flatMap[A, B](fa: Toggle[A])(f: A => Toggle[B]): Toggle[B]
Definition Classes
Inherited from:
ToggleFlatMap
def flatTap[A, B](fa: Toggle[A])(f: A => Toggle[B]): Toggle[A]

Apply a monadic function and discard the result while keeping the effect.

Apply a monadic function and discard the result while keeping the effect.

scala> import cats._, implicits._
scala> Option(1).flatTap(_ => None)
res0: Option[Int] = None
scala> Option(1).flatTap(_ => Some("123"))
res1: Option[Int] = Some(1)
scala> def nCats(n: Int) = List.fill(n)("cat")
nCats: (n: Int)List[String]
scala> List[Int](0).flatTap(nCats)
res2: List[Int] = List()
scala> List[Int](4).flatTap(nCats)
res3: List[Int] = List(4, 4, 4, 4)
Inherited from:
FlatMap
def flatten[A](ffa: Toggle[Toggle[A]]): Toggle[A]

"flatten" a nested F of F structure into a single-layer F structure.

"flatten" a nested F of F structure into a single-layer F structure.

This is also commonly called join.

Example:

scala> import cats.Eval
scala> import cats.implicits._

scala> val nested: Eval[Eval[Int]] = Eval.now(Eval.now(3))
scala> val flattened: Eval[Int] = nested.flatten
scala> flattened.value
res0: Int = 3
Inherited from:
FlatMap
final def fmap[A, B](fa: Toggle[A])(f: A => B): Toggle[B]

Alias for map, since map can't be injected as syntax if the implementing type already had a built-in .map method.

Alias for map, since map can't be injected as syntax if the implementing type already had a built-in .map method.

Example:

scala> import cats.implicits._

scala> val m: Map[Int, String] = Map(1 -> "hi", 2 -> "there", 3 -> "you")

scala> m.fmap(_ ++ "!")
res0: Map[Int,String] = Map(1 -> hi!, 2 -> there!, 3 -> you!)
Inherited from:
Functor
def foreverM[A, B](fa: Toggle[A]): Toggle[B]

Like an infinite loop of >> calls. This is most useful effect loops that you want to run forever in for instance a server.

Like an infinite loop of >> calls. This is most useful effect loops that you want to run forever in for instance a server.

This will be an infinite loop, or it will return an F[Nothing].

Be careful using this. For instance, a List of length k will produce a list of length k^n at iteration n. This means if k = 0, we return an empty list, if k = 1, we loop forever allocating single element lists, but if we have a k > 1, we will allocate exponentially increasing memory and very quickly OOM.

Inherited from:
FlatMap
def fproduct[A, B](fa: Toggle[A])(f: A => B): Toggle[(A, B)]

Tuple the values in fa with the result of applying a function with the value

Tuple the values in fa with the result of applying a function with the value

Example:

scala> import cats.Functor
scala> import cats.implicits.catsStdInstancesForOption

scala> Functor[Option].fproduct(Option(42))(_.toString)
res0: Option[(Int, String)] = Some((42,42))
Inherited from:
Functor
def fproductLeft[A, B](fa: Toggle[A])(f: A => B): Toggle[(B, A)]

Pair the result of function application with A.

Pair the result of function application with A.

Example:

scala> import cats.Functor
scala> import cats.implicits.catsStdInstancesForOption

scala> Functor[Option].fproductLeft(Option(42))(_.toString)
res0: Option[(String, Int)] = Some((42,42))
Inherited from:
Functor
def ifElseM[A](branches: (Toggle[Boolean], Toggle[A])*)(els: Toggle[A]): Toggle[A]

Simulates an if/else-if/else in the context of an F. It evaluates conditions until one evaluates to true, and returns the associated F[A]. If no condition is true, returns els.

Simulates an if/else-if/else in the context of an F. It evaluates conditions until one evaluates to true, and returns the associated F[A]. If no condition is true, returns els.

scala> import cats._
scala> Monad[Eval].ifElseM(Eval.later(false) -> Eval.later(1), Eval.later(true) -> Eval.later(2))(Eval.later(5)).value
res0: Int = 2

Based on a gist by Daniel Spiewak with a stack-safe implementation due to P. Oscar Boykin

See also:
Inherited from:
Monad
def ifF[A](fb: Toggle[Boolean])(ifTrue: => A, ifFalse: => A): Toggle[A]

Lifts if to Functor

Lifts if to Functor

Example:

scala> import cats.Functor
scala> import cats.implicits.catsStdInstancesForList

scala> Functor[List].ifF(List(true, false, false))(1, 0)
res0: List[Int] = List(1, 0, 0)
Inherited from:
Functor
def ifM[B](fa: Toggle[Boolean])(ifTrue: => Toggle[B], ifFalse: => Toggle[B]): Toggle[B]

if lifted into monad.

if lifted into monad.

Inherited from:
FlatMap
override def imap[A, B](fa: Toggle[A])(f: A => B)(g: B => A): Toggle[B]
Definition Classes
Inherited from:
Functor
def iterateForeverM[A, B](a: A)(f: A => Toggle[A]): Toggle[B]

iterateForeverM is almost exclusively useful for effect types. For instance, A may be some state, we may take the current state, run some effect to get a new state and repeat.

iterateForeverM is almost exclusively useful for effect types. For instance, A may be some state, we may take the current state, run some effect to get a new state and repeat.

Inherited from:
FlatMap
def iterateUntil[A](f: Toggle[A])(p: A => Boolean): Toggle[A]

Execute an action repeatedly until its result satisfies the given predicate and return that result, discarding all others.

Execute an action repeatedly until its result satisfies the given predicate and return that result, discarding all others.

Inherited from:
Monad
def iterateUntilM[A](init: A)(f: A => Toggle[A])(p: A => Boolean): Toggle[A]

Apply a monadic function iteratively until its result satisfies the given predicate and return that result.

Apply a monadic function iteratively until its result satisfies the given predicate and return that result.

Inherited from:
Monad
def iterateWhile[A](f: Toggle[A])(p: A => Boolean): Toggle[A]

Execute an action repeatedly until its result fails to satisfy the given predicate and return that result, discarding all others.

Execute an action repeatedly until its result fails to satisfy the given predicate and return that result, discarding all others.

Inherited from:
Monad
def iterateWhileM[A](init: A)(f: A => Toggle[A])(p: A => Boolean): Toggle[A]

Apply a monadic function iteratively until its result fails to satisfy the given predicate and return that result.

Apply a monadic function iteratively until its result fails to satisfy the given predicate and return that result.

Inherited from:
Monad
def lift[A, B](f: A => B): Toggle[A] => Toggle[B]

Lift a function f to operate on Functors

Lift a function f to operate on Functors

Example:

scala> import cats.Functor
scala> import cats.implicits.catsStdInstancesForOption

scala> val o = Option(42)
scala> Functor[Option].lift((x: Int) => x + 10)(o)
res0: Option[Int] = Some(52)
Inherited from:
Functor
override def map[A, B](fa: Toggle[A])(f: A => B): Toggle[B]
Definition Classes
Inherited from:
Monad
def map10[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9) => Z): Toggle[Z]
Inherited from:
ApplyArityFunctions
def map11[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10) => Z): Toggle[Z]
Inherited from:
ApplyArityFunctions
def map12[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11) => Z): Toggle[Z]
Inherited from:
ApplyArityFunctions
def map13[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12) => Z): Toggle[Z]
Inherited from:
ApplyArityFunctions
def map14[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13) => Z): Toggle[Z]
Inherited from:
ApplyArityFunctions
def map15[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14) => Z): Toggle[Z]
Inherited from:
ApplyArityFunctions
def map16[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15) => Z): Toggle[Z]
Inherited from:
ApplyArityFunctions
def map17[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15], f16: Toggle[A16])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16) => Z): Toggle[Z]
Inherited from:
ApplyArityFunctions
def map18[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15], f16: Toggle[A16], f17: Toggle[A17])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17) => Z): Toggle[Z]
Inherited from:
ApplyArityFunctions
def map19[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15], f16: Toggle[A16], f17: Toggle[A17], f18: Toggle[A18])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18) => Z): Toggle[Z]
Inherited from:
ApplyArityFunctions
override def map2[A, B, Z](fa: Toggle[A], fb: Toggle[B])(f: (A, B) => Z): Toggle[Z]
Definition Classes
Inherited from:
FlatMap
def map20[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15], f16: Toggle[A16], f17: Toggle[A17], f18: Toggle[A18], f19: Toggle[A19])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19) => Z): Toggle[Z]
Inherited from:
ApplyArityFunctions
def map21[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15], f16: Toggle[A16], f17: Toggle[A17], f18: Toggle[A18], f19: Toggle[A19], f20: Toggle[A20])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20) => Z): Toggle[Z]
Inherited from:
ApplyArityFunctions
def map22[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15], f16: Toggle[A16], f17: Toggle[A17], f18: Toggle[A18], f19: Toggle[A19], f20: Toggle[A20], f21: Toggle[A21])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21) => Z): Toggle[Z]
Inherited from:
ApplyArityFunctions
override def map2Eval[A, B, Z](fa: Toggle[A], fb: Eval[Toggle[B]])(f: (A, B) => Z): Eval[Toggle[Z]]
Definition Classes
Inherited from:
FlatMap
def map3[A0, A1, A2, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2])(f: (A0, A1, A2) => Z): Toggle[Z]
Inherited from:
ApplyArityFunctions
def map4[A0, A1, A2, A3, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3])(f: (A0, A1, A2, A3) => Z): Toggle[Z]
Inherited from:
ApplyArityFunctions
def map5[A0, A1, A2, A3, A4, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4])(f: (A0, A1, A2, A3, A4) => Z): Toggle[Z]
Inherited from:
ApplyArityFunctions
def map6[A0, A1, A2, A3, A4, A5, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5])(f: (A0, A1, A2, A3, A4, A5) => Z): Toggle[Z]
Inherited from:
ApplyArityFunctions
def map7[A0, A1, A2, A3, A4, A5, A6, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6])(f: (A0, A1, A2, A3, A4, A5, A6) => Z): Toggle[Z]
Inherited from:
ApplyArityFunctions
def map8[A0, A1, A2, A3, A4, A5, A6, A7, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7])(f: (A0, A1, A2, A3, A4, A5, A6, A7) => Z): Toggle[Z]
Inherited from:
ApplyArityFunctions
def map9[A0, A1, A2, A3, A4, A5, A6, A7, A8, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8])(f: (A0, A1, A2, A3, A4, A5, A6, A7, A8) => Z): Toggle[Z]
Inherited from:
ApplyArityFunctions
def mproduct[A, B](fa: Toggle[A])(f: A => Toggle[B]): Toggle[(A, B)]

Pair A with the result of function application.

Pair A with the result of function application.

Example:

scala> import cats.implicits._
scala> List("12", "34", "56").mproduct(_.toList)
res0: List[(String, Char)] = List((12,1), (12,2), (34,3), (34,4), (56,5), (56,6))
Inherited from:
FlatMap
def point[A](a: A): Toggle[A]

point lifts any value into a Monoidal Functor.

point lifts any value into a Monoidal Functor.

Example:

scala> import cats.implicits._

scala> InvariantMonoidal[Option].point(10)
res0: Option[Int] = Some(10)
Inherited from:
InvariantMonoidal
override def product[A, B](fa: Toggle[A], fb: Toggle[B]): Toggle[(A, B)]
Definition Classes
Inherited from:
FlatMap
override def productL[A, B](fa: Toggle[A])(fb: Toggle[B]): Toggle[A]
Definition Classes
Inherited from:
FlatMap
def productLEval[A, B](fa: Toggle[A])(fb: Eval[Toggle[B]]): Toggle[A]

Sequentially compose two actions, discarding any value produced by the second. This variant of productL also lets you define the evaluation strategy of the second action. For instance you can evaluate it only ''after'' the first action has finished:

Sequentially compose two actions, discarding any value produced by the second. This variant of productL also lets you define the evaluation strategy of the second action. For instance you can evaluate it only ''after'' the first action has finished:

scala> import cats.Eval
scala> import cats.implicits._
scala> var count = 0
scala> val fa: Option[Int] = Some(3)
scala> def fb: Option[Unit] = Some(count += 1)
scala> fa.productLEval(Eval.later(fb))
res0: Option[Int] = Some(3)
scala> assert(count == 1)
scala> none[Int].productLEval(Eval.later(fb))
res1: Option[Int] = None
scala> assert(count == 1)
Inherited from:
FlatMap
override def productR[A, B](fa: Toggle[A])(fb: Toggle[B]): Toggle[B]
Definition Classes
Inherited from:
FlatMap
def productREval[A, B](fa: Toggle[A])(fb: Eval[Toggle[B]]): Toggle[B]

Sequentially compose two actions, discarding any value produced by the first. This variant of productR also lets you define the evaluation strategy of the second action. For instance you can evaluate it only ''after'' the first action has finished:

Sequentially compose two actions, discarding any value produced by the first. This variant of productR also lets you define the evaluation strategy of the second action. For instance you can evaluate it only ''after'' the first action has finished:

scala> import cats.Eval
scala> import cats.implicits._
scala> val fa: Option[Int] = Some(3)
scala> def fb: Option[String] = Some("foo")
scala> fa.productREval(Eval.later(fb))
res0: Option[String] = Some(foo)
Inherited from:
FlatMap
def replicateA[A](n: Int, fa: Toggle[A]): Toggle[List[A]]

Given fa and n, apply fa n times to construct an F[List[A]] value.

Given fa and n, apply fa n times to construct an F[List[A]] value.

Example:

scala> import cats.data.State

scala> type Counter[A] = State[Int, A]
scala> val getAndIncrement: Counter[Int] = State { i => (i + 1, i) }
scala> val getAndIncrement5: Counter[List[Int]] =
    | Applicative[Counter].replicateA(5, getAndIncrement)
scala> getAndIncrement5.run(0).value
res0: (Int, List[Int]) = (5,List(0, 1, 2, 3, 4))
Inherited from:
Applicative
override def tailRecM[A, B](a: A)(f: A => Toggle[Either[A, B]]): Toggle[B]
Definition Classes
Inherited from:
ToggleFlatMap
def tuple10[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9]): Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9)]
Inherited from:
ApplyArityFunctions
def tuple11[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10]): Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10)]
Inherited from:
ApplyArityFunctions
def tuple12[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11]): Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11)]
Inherited from:
ApplyArityFunctions
def tuple13[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12]): Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12)]
Inherited from:
ApplyArityFunctions
def tuple14[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13]): Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13)]
Inherited from:
ApplyArityFunctions
def tuple15[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14]): Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14)]
Inherited from:
ApplyArityFunctions
def tuple16[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15]): Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15)]
Inherited from:
ApplyArityFunctions
def tuple17[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15], f16: Toggle[A16]): Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16)]
Inherited from:
ApplyArityFunctions
def tuple18[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15], f16: Toggle[A16], f17: Toggle[A17]): Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17)]
Inherited from:
ApplyArityFunctions
def tuple19[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15], f16: Toggle[A16], f17: Toggle[A17], f18: Toggle[A18]): Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18)]
Inherited from:
ApplyArityFunctions
def tuple2[A, B](f1: Toggle[A], f2: Toggle[B]): Toggle[(A, B)]
Inherited from:
ApplyArityFunctions
def tuple20[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15], f16: Toggle[A16], f17: Toggle[A17], f18: Toggle[A18], f19: Toggle[A19]): Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19)]
Inherited from:
ApplyArityFunctions
def tuple21[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15], f16: Toggle[A16], f17: Toggle[A17], f18: Toggle[A18], f19: Toggle[A19], f20: Toggle[A20]): Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20)]
Inherited from:
ApplyArityFunctions
def tuple22[A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8], f9: Toggle[A9], f10: Toggle[A10], f11: Toggle[A11], f12: Toggle[A12], f13: Toggle[A13], f14: Toggle[A14], f15: Toggle[A15], f16: Toggle[A16], f17: Toggle[A17], f18: Toggle[A18], f19: Toggle[A19], f20: Toggle[A20], f21: Toggle[A21]): Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8, A9, A10, A11, A12, A13, A14, A15, A16, A17, A18, A19, A20, A21)]
Inherited from:
ApplyArityFunctions
def tuple3[A0, A1, A2, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2]): Toggle[(A0, A1, A2)]
Inherited from:
ApplyArityFunctions
def tuple4[A0, A1, A2, A3, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3]): Toggle[(A0, A1, A2, A3)]
Inherited from:
ApplyArityFunctions
def tuple5[A0, A1, A2, A3, A4, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4]): Toggle[(A0, A1, A2, A3, A4)]
Inherited from:
ApplyArityFunctions
def tuple6[A0, A1, A2, A3, A4, A5, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5]): Toggle[(A0, A1, A2, A3, A4, A5)]
Inherited from:
ApplyArityFunctions
def tuple7[A0, A1, A2, A3, A4, A5, A6, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6]): Toggle[(A0, A1, A2, A3, A4, A5, A6)]
Inherited from:
ApplyArityFunctions
def tuple8[A0, A1, A2, A3, A4, A5, A6, A7, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7]): Toggle[(A0, A1, A2, A3, A4, A5, A6, A7)]
Inherited from:
ApplyArityFunctions
def tuple9[A0, A1, A2, A3, A4, A5, A6, A7, A8, Z](f0: Toggle[A0], f1: Toggle[A1], f2: Toggle[A2], f3: Toggle[A3], f4: Toggle[A4], f5: Toggle[A5], f6: Toggle[A6], f7: Toggle[A7], f8: Toggle[A8]): Toggle[(A0, A1, A2, A3, A4, A5, A6, A7, A8)]
Inherited from:
ApplyArityFunctions
def tupleLeft[A, B](fa: Toggle[A], b: B): Toggle[(B, A)]

Tuples the A value in F[A] with the supplied B value, with the B value on the left.

Tuples the A value in F[A] with the supplied B value, with the B value on the left.

Example:

scala> import scala.collection.immutable.Queue
scala> import cats.Functor
scala> import cats.implicits.catsStdInstancesForQueue

scala> Functor[Queue].tupleLeft(Queue("hello", "world"), 42)
res0: scala.collection.immutable.Queue[(Int, String)] = Queue((42,hello), (42,world))
Inherited from:
Functor
def tupleRight[A, B](fa: Toggle[A], b: B): Toggle[(A, B)]

Tuples the A value in F[A] with the supplied B value, with the B value on the right.

Tuples the A value in F[A] with the supplied B value, with the B value on the right.

Example:

scala> import scala.collection.immutable.Queue
scala> import cats.Functor
scala> import cats.implicits.catsStdInstancesForQueue

scala> Functor[Queue].tupleRight(Queue("hello", "world"), 42)
res0: scala.collection.immutable.Queue[(String, Int)] = Queue((hello,42), (world,42))
Inherited from:
Functor
def unit: Toggle[Unit]

Returns an F[Unit] value, equivalent with pure(()).

Returns an F[Unit] value, equivalent with pure(()).

A useful shorthand, also allowing implementations to optimize the returned reference (e.g. it can be a val).

Example:

scala> import cats.implicits._

scala> Applicative[Option].unit
res0: Option[Unit] = Some(())
Inherited from:
Applicative
def unlessA[A](cond: Boolean)(f: => Toggle[A]): Toggle[Unit]

Returns the given argument (mapped to Unit) if cond is false, otherwise, unit lifted into F.

Returns the given argument (mapped to Unit) if cond is false, otherwise, unit lifted into F.

Example:

scala> import cats.implicits._

scala> Applicative[List].unlessA(true)(List(1, 2, 3))
res0: List[Unit] = List(())

scala> Applicative[List].unlessA(false)(List(1, 2, 3))
res1: List[Unit] = List((), (), ())

scala> Applicative[List].unlessA(true)(List.empty[Int])
res2: List[Unit] = List(())

scala> Applicative[List].unlessA(false)(List.empty[Int])
res3: List[Unit] = List()
Inherited from:
Applicative
def untilDefinedM[A](foa: Toggle[Option[A]]): Toggle[A]

This repeats an F until we get defined values. This can be useful for polling type operations on State (or RNG) Monads, or in effect monads.

This repeats an F until we get defined values. This can be useful for polling type operations on State (or RNG) Monads, or in effect monads.

Inherited from:
FlatMap
def untilM[G[_], A](f: Toggle[A])(cond: => Toggle[Boolean])(implicit G: Alternative[G]): Toggle[G[A]]

Execute an action repeatedly until the Boolean condition returns true. The condition is evaluated after the loop body. Collects results into an arbitrary Alternative value, such as a Vector. This implementation uses append on each evaluation result, so avoid data structures with non-constant append performance, e.g. List.

Execute an action repeatedly until the Boolean condition returns true. The condition is evaluated after the loop body. Collects results into an arbitrary Alternative value, such as a Vector. This implementation uses append on each evaluation result, so avoid data structures with non-constant append performance, e.g. List.

Inherited from:
Monad
def untilM_[A](f: Toggle[A])(cond: => Toggle[Boolean]): Toggle[Unit]

Execute an action repeatedly until the Boolean condition returns true. The condition is evaluated after the loop body. Discards results.

Execute an action repeatedly until the Boolean condition returns true. The condition is evaluated after the loop body. Discards results.

Inherited from:
Monad
def unzip[A, B](fab: Toggle[(A, B)]): (Toggle[A], Toggle[B])

Un-zips an F[(A, B)] consisting of element pairs or Tuple2 into two separate F's tupled.

Un-zips an F[(A, B)] consisting of element pairs or Tuple2 into two separate F's tupled.

NOTE: Check for effect duplication, possibly memoize before

scala> import cats.Functor
scala> import cats.implicits.catsStdInstancesForList

scala> Functor[List].unzip(List((1,2), (3, 4)))
res0: (List[Int], List[Int]) = (List(1, 3),List(2, 4))
Inherited from:
Functor
def void[A](fa: Toggle[A]): Toggle[Unit]

Empty the fa of the values, preserving the structure

Empty the fa of the values, preserving the structure

Example:

scala> import cats.Functor
scala> import cats.implicits.catsStdInstancesForList

scala> Functor[List].void(List(1,2,3))
res0: List[Unit] = List((), (), ())
Inherited from:
Functor
def whenA[A](cond: Boolean)(f: => Toggle[A]): Toggle[Unit]

Returns the given argument (mapped to Unit) if cond is true, otherwise, unit lifted into F.

Returns the given argument (mapped to Unit) if cond is true, otherwise, unit lifted into F.

Example:

scala> import cats.implicits._

scala> Applicative[List].whenA(true)(List(1, 2, 3))
res0: List[Unit] = List((), (), ())

scala> Applicative[List].whenA(false)(List(1, 2, 3))
res1: List[Unit] = List(())

scala> Applicative[List].whenA(true)(List.empty[Int])
res2: List[Unit] = List()

scala> Applicative[List].whenA(false)(List.empty[Int])
res3: List[Unit] = List(())
Inherited from:
Applicative
def whileM[G[_], A](p: Toggle[Boolean])(body: => Toggle[A])(implicit G: Alternative[G]): Toggle[G[A]]

Execute an action repeatedly as long as the given Boolean expression returns true. The condition is evaluated before the loop body. Collects the results into an arbitrary Alternative value, such as a Vector. This implementation uses append on each evaluation result, so avoid data structures with non-constant append performance, e.g. List.

Execute an action repeatedly as long as the given Boolean expression returns true. The condition is evaluated before the loop body. Collects the results into an arbitrary Alternative value, such as a Vector. This implementation uses append on each evaluation result, so avoid data structures with non-constant append performance, e.g. List.

Inherited from:
Monad
def whileM_[A](p: Toggle[Boolean])(body: => Toggle[A]): Toggle[Unit]

Execute an action repeatedly as long as the given Boolean expression returns true. The condition is evaluated before the loop body. Discards results.

Execute an action repeatedly as long as the given Boolean expression returns true. The condition is evaluated before the loop body. Discards results.

Inherited from:
Monad
def widen[A, B >: A](fa: Toggle[A]): Toggle[B]

Lifts natural subtyping covariance of covariant Functors.

Lifts natural subtyping covariance of covariant Functors.

NOTE: In certain (perhaps contrived) situations that rely on universal equality this can result in a ClassCastException, because it is implemented as a type cast. It could be implemented as map(identity), but according to the functor laws, that should be equal to fa, and a type cast is often much more performant. See this example of widen creating a ClassCastException.

Example:

scala> import cats.Functor
scala> import cats.implicits.catsStdInstancesForOption

scala> val s = Some(42)
scala> Functor[Option].widen(s)
res0: Option[Int] = Some(42)
Inherited from:
Functor

Deprecated and Inherited methods

@noop @deprecated("Dangerous method, use ifM (a flatMap) or ifF (a map) instead", "2.6.2")
def ifA[A](fcond: Toggle[Boolean])(ifTrue: Toggle[A], ifFalse: Toggle[A]): Toggle[A]
Deprecated
Inherited from:
Apply