iron-cats
API
Generated with
iron-cats/io.github.iltotore.iron/cats

cats

io.github.iltotore.iron.cats
object cats

Attributes

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)
inline given given_Eq_T[T](using mirror: Mirror[T], ev: Eq[IronType]): Eq[T]

Attributes

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

Attributes

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

Attributes

Inherited from:
RefinedTypeOpsCatsLowPriority (hidden)
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)
inline given given_Order_:|[A, C](using inline ev: Order[A]): Order[IronType[A, C]]

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

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

Attributes

Inherited from:
RefinedTypeOpsCats (hidden)
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)
inline given negDoubleCommutativeMonoid[C](using Implication[C, Negative]): CommutativeMonoid[IronType[Double, C]]

Attributes

Inherited from:
IronCatsInstances (hidden)
inline given negFloatCommutativeMonoid[C](using Implication[C, Negative]): CommutativeMonoid[IronType[Float, C]]

Attributes

Inherited from:
IronCatsInstances (hidden)
inline given negIntCommutativeMonoid[C](using Implication[C, Negative]): CommutativeMonoid[IronType[Int, C]]

Attributes

Inherited from:
IronCatsInstances (hidden)
inline given negLongCommutativeMonoid[C](using Implication[C, Negative]): CommutativeMonoid[IronType[Long, C]]

Attributes

Inherited from:
IronCatsInstances (hidden)
inline given posDoubleCommutativeMonoid[C](using Implication[C, Positive]): CommutativeMonoid[IronType[Double, C]]

Attributes

Inherited from:
IronCatsInstances (hidden)
inline given posFloatCommutativeMonoid[C](using Implication[C, Positive]): CommutativeMonoid[IronType[Float, C]]

Attributes

Inherited from:
IronCatsInstances (hidden)
inline given posIntCommutativeMonoid[C](using Implication[C, Positive]): CommutativeMonoid[IronType[Int, C]]

Attributes

Inherited from:
IronCatsInstances (hidden)
inline given posLongCommutativeMonoid[C](using Implication[C, Positive]): CommutativeMonoid[IronType[Long, C]]

Attributes

Inherited from:
IronCatsInstances (hidden)

Extensions

Extensions

extension [A, C, T](ops: RefinedTypeOps[A, C, T])
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.

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.

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
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
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
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

refineEither, refineNel.

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

refineEither, refineNec.

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
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
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
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
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
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
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
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
Generated with