Iron
2.6.0-13-f71de9-SNAPSHOT
DocsAPI
Generated with
Iron/io.github.iltotore.iron/cats

cats

io.github.iltotore.iron.cats
object cats

Attributes

Source
cats.scala
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
cats.type

Members list

Givens

Inherited givens

inline given given_Eq_:|[A, C](using inline ev: Eq[A], notHashOrOrder: NotGiven[Hash[A] | PartialOrder[A]]): Eq[IronType[A, C]]

Attributes

Inherited from:
IronCatsInstances (hidden)
Source
instances.scala
inline given given_Eq_T[T](using mirror: Mirror[T], ev: Eq[mirror.IronType]): Eq[T]

Attributes

Inherited from:
RefinedTypeOpsCats (hidden)
Source
instances.scala
inline given given_Hash_:|[A, C](using inline ev: Hash[A]): Hash[IronType[A, C]]

Attributes

Inherited from:
IronCatsLowPriority (hidden)
Source
instances.scala
inline given given_Hash_T[T](using mirror: Mirror[T], ev: Hash[mirror.IronType]): Hash[T]

Attributes

Inherited from:
RefinedTypeOpsCatsLowPriority (hidden)
Source
instances.scala
inline given given_LowerBounded_:|[A, C, V](using inline ev: LowerBounded[A], implication: Implication[C, Greater[V]]): LowerBounded[IronType[A, C]]

Attributes

Inherited from:
IronCatsInstances (hidden)
Source
instances.scala
given given_MapLogic_F[F[_]](using functor: Functor[F]): given_MapLogic_F[F]

Attributes

Inherited from:
IronCatsInstances (hidden)
Source
instances.scala
inline given given_Order_:|[A, C](using inline ev: Order[A]): Order[IronType[A, C]]

Attributes

Inherited from:
IronCatsInstances (hidden)
Source
instances.scala
inline given given_Order_T[T](using mirror: Mirror[T], ev: Order[mirror.IronType]): Order[T]

Attributes

Inherited from:
RefinedTypeOpsCats (hidden)
Source
instances.scala
inline given given_PartialOrder_:|[A, C](using inline ev: PartialOrder[A], notOrder: NotGiven[Order[A]]): PartialOrder[IronType[A, C]]

Attributes

Inherited from:
IronCatsInstances (hidden)
Source
instances.scala
inline given given_PartialOrder_T[T](using mirror: Mirror[T], ev: PartialOrder[mirror.IronType]): PartialOrder[T]

Attributes

Inherited from:
RefinedTypeOpsCats (hidden)
Source
instances.scala
inline given given_Show_:|[A, C](using inline ev: Show[A]): Show[IronType[A, C]]

Attributes

Inherited from:
IronCatsInstances (hidden)
Source
instances.scala
inline given given_Show_T[T](using mirror: Mirror[T], ev: Show[mirror.IronType]): Show[T]

Attributes

Inherited from:
RefinedTypeOpsCats (hidden)
Source
instances.scala
inline given given_UpperBounded_:|[A, C, V](using inline ev: UpperBounded[A], implication: Implication[C, Greater[V]]): UpperBounded[IronType[A, C]]

Attributes

Inherited from:
IronCatsInstances (hidden)
Source
instances.scala
given multiplicativeGroup[A, C](using inner: MultiplicativeGroup[A]): MultiplicativeGroup[IronType[A, C]]

Attributes

Inherited from:
RefinedTypeOpsCatsLowPriority (hidden)
Source
instances.scala
given multiplicativeMonoid[A, C](using inner: MultiplicativeMonoid[A]): MultiplicativeMonoid[IronType[A, C]]

Attributes

Inherited from:
RefinedTypeOpsCatsLowPriority (hidden)
Source
instances.scala
given negDoubleAdditiveCommutativeMonoid: AdditiveCommutativeMonoid[IronType[Double, Negative0]]

Attributes

Inherited from:
RefinedTypeOpsCatsLowPriority (hidden)
Source
instances.scala
given negDoubleAdditiveCommutativeSemigroup: AdditiveCommutativeSemigroup[IronType[Double, Negative]]

Attributes

Inherited from:
RefinedTypeOpsCatsLowPriority (hidden)
Source
instances.scala
given negFloatAdditiveCommutativeMonoid: AdditiveCommutativeMonoid[IronType[Float, Negative0]]

Attributes

Inherited from:
RefinedTypeOpsCatsLowPriority (hidden)
Source
instances.scala
given negFloatAdditiveCommutativeSemigroup: AdditiveCommutativeSemigroup[IronType[Float, Negative]]

Attributes

Inherited from:
RefinedTypeOpsCatsLowPriority (hidden)
Source
instances.scala
given negIntAdditiveCommutativeMonoid: AdditiveCommutativeMonoid[IronType[Int, Negative0]]

Attributes

Inherited from:
RefinedTypeOpsCatsLowPriority (hidden)
Source
instances.scala
given negIntAdditiveCommutativeSemigroup: AdditiveCommutativeSemigroup[IronType[Int, Negative]]

Attributes

Inherited from:
RefinedTypeOpsCatsLowPriority (hidden)
Source
instances.scala
given negLongAdditiveCommutativeMonoid: AdditiveCommutativeMonoid[IronType[Long, Negative0]]

Attributes

Inherited from:
RefinedTypeOpsCatsLowPriority (hidden)
Source
instances.scala
given negLongAdditiveCommutativeSemigroup: AdditiveCommutativeSemigroup[IronType[Long, Negative]]

Attributes

Inherited from:
RefinedTypeOpsCatsLowPriority (hidden)
Source
instances.scala
given posDoubleAdditiveCommutativeMonoid: AdditiveCommutativeMonoid[IronType[Double, Positive0]]

Attributes

Inherited from:
RefinedTypeOpsCatsLowPriority (hidden)
Source
instances.scala
given posDoubleAdditiveCommutativeSemigroup: AdditiveCommutativeSemigroup[IronType[Double, Positive]]

Attributes

Inherited from:
RefinedTypeOpsCatsLowPriority (hidden)
Source
instances.scala
given posFloatAdditiveCommutativeMonoid: AdditiveCommutativeMonoid[IronType[Float, Positive0]]

Attributes

Inherited from:
RefinedTypeOpsCatsLowPriority (hidden)
Source
instances.scala
given posFloatAdditiveCommutativeSemigroup: AdditiveCommutativeSemigroup[IronType[Float, Positive]]

Attributes

Inherited from:
RefinedTypeOpsCatsLowPriority (hidden)
Source
instances.scala
given posIntAdditiveCommutativeMonoid: AdditiveCommutativeMonoid[IronType[Int, Positive0]]

Attributes

Inherited from:
RefinedTypeOpsCatsLowPriority (hidden)
Source
instances.scala
given posIntAdditiveCommutativeSemigroup: AdditiveCommutativeSemigroup[IronType[Int, Positive]]

Attributes

Inherited from:
RefinedTypeOpsCatsLowPriority (hidden)
Source
instances.scala
given posLongAdditiveCommutativeMonoid: AdditiveCommutativeMonoid[IronType[Long, Positive0]]

Attributes

Inherited from:
RefinedTypeOpsCatsLowPriority (hidden)
Source
instances.scala
given posLongAdditiveCommutativeSemigroup: AdditiveCommutativeSemigroup[IronType[Long, Positive]]

Attributes

Inherited from:
RefinedTypeOpsCatsLowPriority (hidden)
Source
instances.scala

Extensions

Extensions

extension [A, C, T](ops: RefinedTypeOps[A, C, T])
def eitherAllNec[F[_]](value: F[A])(using Traverse[F]): EitherNec[InvalidValue[A], F[T]]

Refine the given values applicatively at runtime, resulting in a EitherNec.

Refine the given values applicatively at runtime, resulting in a EitherNec.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Right containing this value as IronType or an Left containing a NonEmptyChain of error messages.

See also
Source
cats.scala
def eitherAllNel[F[_]](value: F[A])(using Traverse[F]): EitherNel[InvalidValue[A], F[T]]

Refine the given values applicatively at runtime, resulting in a EitherNel.

Refine the given values applicatively at runtime, resulting in a EitherNel.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Right containing this value as IronType or an Left containing a NonEmptyList of error messages.

See also
Source
cats.scala
def eitherNec(value: A): EitherNec[String, T]

Refine the given value at runtime, resulting in an EitherNec.

Refine the given value at runtime, resulting in an EitherNec.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Right containing this value as IronType or a Left containing the constraint message.

See also

either, eitherNel.

Source
cats.scala
def eitherNel(value: A): EitherNel[String, T]

Refine the given value at runtime, resulting in an EitherNel.

Refine the given value at runtime, resulting in an EitherNel.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Right containing this value as IronType or a Left containing the constraint message.

See also

either, eitherNec.

Source
cats.scala
def validated(value: A): Validated[String, T]

Refine the given value at runtime, resulting in a Validated.

Refine the given value at runtime, resulting in a Validated.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Valid containing this value as IronType or an Invalid containing the constraint message.

See also
Source
cats.scala
def validatedAllNec[F[_]](wrapper: F[A])(using traverse: Traverse[F]): ValidatedNec[InvalidValue[A], F[T]]

Refine the given values applicatively at runtime, resulting in a ValidatedNec.

Refine the given values applicatively at runtime, resulting in a ValidatedNec.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Valid containing this value as IronType or an Invalid containing a NonEmptyChain of error messages.

See also
Source
cats.scala
def validatedAllNel[F[_]](wrapper: F[A])(using traverse: Traverse[F]): ValidatedNel[InvalidValue[A], F[T]]

Refine the given values applicatively at runtime, resulting in a ValidatedNel.

Refine the given values applicatively at runtime, resulting in a ValidatedNel.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Valid containing this value as IronType or an Invalid containing a NonEmptyList of error messages.

See also
Source
cats.scala
def validatedNec(value: A): ValidatedNec[String, T]

Refine the given value applicatively at runtime, resulting in a ValidatedNec.

Refine the given value applicatively at runtime, resulting in a ValidatedNec.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Valid containing this value as IronType or an Invalid containing a NonEmptyChain of error messages.

See also
Source
cats.scala
def validatedNel(value: A): ValidatedNel[String, T]

Refine the given value applicatively at runtime, resulting in a ValidatedNel.

Refine the given value applicatively at runtime, resulting in a ValidatedNel.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Valid containing this value as IronType or an Invalid containing a NonEmptyList of error messages.

See also
Source
cats.scala
extension [A](value: A)
inline def refineNec[C](using inline constraint: Constraint[A, C]): EitherNec[String, IronType[A, C]]

Refine the given value at runtime, resulting in an EitherNec.

Refine the given value at runtime, resulting in an EitherNec.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Right containing this value as IronType or a Left containing the constraint message.

See also
Source
cats.scala
inline def refineNel[C](using inline constraint: Constraint[A, C]): EitherNel[String, IronType[A, C]]

Refine the given value at runtime, resulting in an EitherNel.

Refine the given value at runtime, resulting in an EitherNel.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Right containing this value as IronType or a Left containing the constraint message.

See also
Source
cats.scala
inline def refineValidated[C](using inline constraint: Constraint[A, C]): Validated[String, IronType[A, C]]

Refine the given value at runtime, resulting in a Validated.

Refine the given value at runtime, resulting in a Validated.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Valid containing this value as IronType or an Invalid containing the constraint message.

See also
Source
cats.scala
inline def refineValidatedNec[C](using inline constraint: Constraint[A, C]): ValidatedNec[String, IronType[A, C]]

Refine the given value applicatively at runtime, resulting in a ValidatedNec.

Refine the given value applicatively at runtime, resulting in a ValidatedNec.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Valid containing this value as IronType or an Invalid containing a NonEmptyChain of error messages.

See also
Source
cats.scala
inline def refineValidatedNel[C](using inline constraint: Constraint[A, C]): ValidatedNel[String, IronType[A, C]]

Refine the given value applicatively at runtime, resulting in a ValidatedNel.

Refine the given value applicatively at runtime, resulting in a ValidatedNel.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Valid containing this value as IronType or an Invalid containing a NonEmptyList of error messages.

See also
Source
cats.scala
extension [A, C1](value: IronType[A, C1])
inline def refineFurtherNec[C2](using inline constraint: Constraint[A, C2]): EitherNec[String, IronType[A, C1 & C2]]

Refine the given value again at runtime, resulting in an EitherNec.

Refine the given value again at runtime, resulting in an EitherNec.

Value parameters

constraint

the new constraint to test.

Attributes

Returns

a Right containing this refined with C1 & C2 or a Left containing the constraint message.

See also
Source
cats.scala
inline def refineFurtherNel[C2](using inline constraint: Constraint[A, C2]): EitherNel[String, IronType[A, C1 & C2]]

Refine the given value again at runtime, resulting in an EitherNel.

Refine the given value again at runtime, resulting in an EitherNel.

Value parameters

constraint

the new constraint to test.

Attributes

Returns

a Right containing this refined with C1 & C2 or a Left containing the constraint message.

See also
Source
cats.scala
inline def refineFurtherValidated[C2](using inline constraint: Constraint[A, C2]): Validated[String, IronType[A, C1 & C2]]

Refine the given value again at runtime, resulting in an Validated.

Refine the given value again at runtime, resulting in an Validated.

Value parameters

constraint

the new constraint to test.

Attributes

Returns

a Validated.Valid containing this refined with C1 & C2 or a Validated.Invalid containing the constraint message.

See also
Source
cats.scala
inline def refineFurtherValidatedNec[C2](using inline constraint: Constraint[A, C2]): ValidatedNec[String, IronType[A, C1 & C2]]

Refine the given value again applicatively at runtime, resulting in a ValidatedNec.

Refine the given value again applicatively at runtime, resulting in a ValidatedNec.

Value parameters

constraint

the new constraint to test.

Attributes

Returns

a Valid containing this value as IronType or an Invalid containing a NonEmptyChain of error messages.

See also
Source
cats.scala
inline def refineFurtherValidatedNel[C2](using inline constraint: Constraint[A, C2]): ValidatedNel[String, IronType[A, C1 & C2]]

Refine the given value again applicatively at runtime, resulting in a ValidatedNel.

Refine the given value again applicatively at runtime, resulting in a ValidatedNel.

Value parameters

constraint

the new constraint to test.

Attributes

Returns

a Valid containing this value as IronType or an Invalid containing a NonEmptyList of error messages.

See also
Source
cats.scala
extension [F[_], A](wrapper: F[A])
inline def refineAllNec[C](using traverse: Traverse[F], inline constraint: Constraint[A, C]): EitherNec[InvalidValue[A], F[IronType[A, C]]]

Refine the wrapped value(s) at runtime, accumulating errors.

Refine the wrapped value(s) at runtime, accumulating errors.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Right containing this value as IronType or an Left containing a NonEmptyChain of errors.

See also
Source
cats.scala
inline def refineAllNel[C](using traverse: Traverse[F], inline constraint: Constraint[A, C]): EitherNel[InvalidValue[A], F[IronType[A, C]]]

Refine the wrapped value(s) at runtime, accumulating errors.

Refine the wrapped value(s) at runtime, accumulating errors.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Right containing this value as IronType or an Left containing a NonEmptyList of errors.

See also
Source
cats.scala
inline def refineAllValidatedNec[C](using traverse: Traverse[F], inline constraint: Constraint[A, C]): ValidatedNec[InvalidValue[A], F[IronType[A, C]]]

Refine the wrapped value(s) at runtime, accumulating errors.

Refine the wrapped value(s) at runtime, accumulating errors.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Valid containing this value as IronType or an Invalid containing a NonEmptyChain of errors.

See also
Source
cats.scala
inline def refineAllValidatedNel[C](using traverse: Traverse[F], inline constraint: Constraint[A, C]): ValidatedNel[InvalidValue[A], F[IronType[A, C]]]

Refine the wrapped value(s) at runtime, accumulating errors.

Refine the wrapped value(s) at runtime, accumulating errors.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Valid containing this value as IronType or an Invalid containing a NonEmptyList of errors.

See also
Source
cats.scala
extension [F[_], A, C1](wrapper: F[IronType[A, C1]])
inline def refineAllFurtherNec[C2](using traverse: Traverse[F], inline constraint: Constraint[A, C2]): EitherNec[InvalidValue[A], F[IronType[A, C1 & C2]]]

Refine further the wrapped value(s) at runtime, accumulating errors.

Refine further the wrapped value(s) at runtime, accumulating errors.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Right containing this value as IronType or an Left containing a NonEmptyChain of errors.

See also
Source
cats.scala
inline def refineAllFurtherNel[C2](using traverse: Traverse[F], inline constraint: Constraint[A, C2]): EitherNel[InvalidValue[A], F[IronType[A, C1 & C2]]]

Refine further the wrapped value(s) at runtime, accumulating errors.

Refine further the wrapped value(s) at runtime, accumulating errors.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Right containing this value as IronType or an Left containing a NonEmptyList of errors.

See also
Source
cats.scala
inline def refineAllFurtherValidatedNec[C2](using traverse: Traverse[F], inline constraint: Constraint[A, C2]): ValidatedNec[InvalidValue[A], F[IronType[A, C1 & C2]]]

Refine further the wrapped value(s) at runtime, accumulating errors.

Refine further the wrapped value(s) at runtime, accumulating errors.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Valid containing this value as IronType or an Invalid containing a NonEmptyChain of errors.

See also
Source
cats.scala
inline def refineAllFurtherValidatedNel[C2](using traverse: Traverse[F], inline constraint: Constraint[A, C2]): ValidatedNel[InvalidValue[A], F[IronType[A, C1 & C2]]]

Refine further the wrapped value(s) at runtime, accumulating errors.

Refine further the wrapped value(s) at runtime, accumulating errors.

Value parameters

constraint

the constraint to test with the value to refine.

Attributes

Returns

a Valid containing this value as IronType or an Invalid containing a NonEmptyList of errors.

See also
Source
cats.scala
Generated with