Object/Class

cats.data

Ior

Related Docs: class Ior | package data

Permalink

object Ior extends IorInstances with IorFunctions with IorFunctions2 with Serializable

Linear Supertypes
Serializable, Serializable, IorFunctions2, IorFunctions, IorInstances, IorInstances0, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Ior
  2. Serializable
  3. Serializable
  4. IorFunctions2
  5. IorFunctions
  6. IorInstances
  7. IorInstances0
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final case class Both[+A, +B](a: A, b: B) extends Ior[A, B] with Product with Serializable

    Permalink
  2. final case class Left[+A](a: A) extends Ior[A, Nothing] with Product with Serializable

    Permalink
  3. final case class Right[+B](b: B) extends Ior[Nothing, B] with Product with Serializable

    Permalink

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def both[A, B](a: A, b: B): Ior[A, B]

    Permalink
    Definition Classes
    IorFunctions
  6. def bothNec[A, B](a: A, b: B): IorNec[A, B]

    Permalink
    Definition Classes
    IorFunctions2
  7. def bothNel[A, B](a: A, b: B): IorNel[A, B]

    Permalink
    Definition Classes
    IorFunctions
  8. implicit val catsBitraverseForIor: Bitraverse[Ior]

    Permalink
    Definition Classes
    IorInstances
  9. implicit def catsDataBifunctorForIor: Bifunctor[Ior]

    Permalink
    Definition Classes
    IorInstances
  10. implicit def catsDataEqForIor[A, B](implicit arg0: Eq[A], arg1: Eq[B]): Eq[Ior[A, B]]

    Permalink
    Definition Classes
    IorInstances
  11. implicit def catsDataMonadErrorForIor[A](implicit arg0: Semigroup[A]): MonadError[[β$0$]Ior[A, β$0$], A]

    Permalink
    Definition Classes
    IorInstances
  12. implicit def catsDataParallelForIor[E](implicit E: Semigroup[E]): Parallel[[β$2$]Ior[E, β$2$], [β$3$]Ior[E, β$3$]]

    Permalink
    Definition Classes
    IorInstances
  13. implicit def catsDataSemigroupForIor[A, B](implicit arg0: Semigroup[A], arg1: Semigroup[B]): Semigroup[Ior[A, B]]

    Permalink
    Definition Classes
    IorInstances
  14. implicit def catsDataShowForIor[A, B](implicit arg0: Show[A], arg1: Show[B]): Show[Ior[A, B]]

    Permalink
    Definition Classes
    IorInstances
  15. implicit def catsDataTraverseFunctorForIor[A]: Traverse[[β$16$]Ior[A, β$16$]]

    Permalink
    Definition Classes
    IorInstances0
  16. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  17. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  18. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  19. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  20. def fromEither[A, B](eab: Either[A, B]): Ior[A, B]

    Permalink

    Create an Ior from an Either.

    Create an Ior from an Either.

    eab

    an Either from which the Ior should be created

    returns

    Ior.Left if the Either was a Left, or Ior.Right if the Either was a Right Example:

    scala> Ior.fromEither(Left(1))
    res0: Ior[Int, Nothing] = Left(1)
    scala> Ior.fromEither(Right('1'))
    res1: Ior[Nothing, Char] = Right(1)
    Definition Classes
    IorFunctions
  21. def fromOptions[A, B](oa: Option[A], ob: Option[B]): Option[Ior[A, B]]

    Permalink

    Create an Ior from two Options if at least one of them is defined.

    Create an Ior from two Options if at least one of them is defined.

    oa

    an element (optional) for the left side of the Ior

    ob

    an element (optional) for the right side of the Ior

    returns

    None if both oa and ob are None. Otherwise Some wrapping an Ior.Left, Ior.Right, or Ior.Both if oa, ob, or both are defined (respectively). Example:

    scala> Ior.fromOptions(Option.empty[String], Option.empty[Int])
    res0: Option[Ior[String, Int]] = None
    scala> Ior.fromOptions(Option.empty[String], Some(42))
    res1: Option[Ior[String, Int]] = Some(Right(42))
    scala> Ior.fromOptions(Some("Error"), Option.empty[Int])
    res2: Option[Ior[String, Int]] = Some(Left(Error))
    scala> Ior.fromOptions(Some("Warning"), Some(42))
    res3: Option[Ior[String, Int]] = Some(Both(Warning,42))
    Definition Classes
    IorFunctions
  22. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  23. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  24. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  25. def left[A, B](a: A): Ior[A, B]

    Permalink
    Definition Classes
    IorFunctions
  26. def leftNec[A, B](a: A): IorNec[A, B]

    Permalink
    Definition Classes
    IorFunctions2
  27. def leftNel[A, B](a: A): IorNel[A, B]

    Permalink
    Definition Classes
    IorFunctions
  28. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  29. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  30. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  31. def right[A, B](b: B): Ior[A, B]

    Permalink
    Definition Classes
    IorFunctions
  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  33. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  34. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  35. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  36. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from Serializable

Inherited from Serializable

Inherited from IorFunctions2

Inherited from IorFunctions

Inherited from IorInstances

Inherited from IorInstances0

Inherited from AnyRef

Inherited from Any

Ungrouped