fields-cats/jap.fields/CatsInterop/DefaultValidatedNelVM

DefaultValidatedNelVM

object DefaultValidatedNelVM extends ValidatedNelVM[Sync, ValidationError]

Default ValidationModule where:

  • ValidationEffect is ValidationEffect.Sync
  • ValidationResult is Validated[NonEmptyList[E], Unit]
  • Error is ValidationError
class ValidatedNelVM[Sync, ValidationError]
class ValidationModule[Sync, ValidatedNelUnit, ValidationError]
trait ValidationResultSyntax
trait FieldSyntax
trait PolicySyntax[Sync, ValidatedNelUnit, ValidationError]
trait MapSyntax[Sync, ValidatedNelUnit, ValidationError]
trait IterableSyntax[Sync, ValidatedNelUnit, ValidationError]
trait StringSyntax[Sync, ValidatedNelUnit, ValidationError]
trait OptionSyntax[Sync, ValidatedNelUnit, ValidationError]
trait NumericSyntax[Sync, ValidatedNelUnit, ValidationError]
trait EffectValidationResultSyntax[Sync, ValidatedNelUnit, ValidationError]
trait BooleanSyntax[Sync, ValidatedNelUnit, ValidationError]
trait FailSyntax[Sync, ValidatedNelUnit, ValidationError]
trait GenericSyntax[Sync, ValidatedNelUnit, ValidationError]
class Object
trait Matchable
class Any

Type members

Inherited classlikes

object Policy
Inherited from:
ValidationModule

Inherited types

type Policy[P] = ValidationPolicy[P, F, VR, E]

Shortcut for ValidationPolicy

Shortcut for ValidationPolicy

Inherited from:
ValidationModule
type PolicyBuilder[P] = ValidationPolicyBuilder[P, F, VR, E]

Shortcut for ValidationPolicyBuilder

Shortcut for ValidationPolicyBuilder

Inherited from:
ValidationModule

Value members

Inherited methods

def and(list: List[Sync[ValidatedNelUnit[ValidationError]]]): Sync[ValidatedNelUnit[ValidationError]]

Combines all validations using AND

Combines all validations using AND

Inherited from:
ValidationModule
def and(a: Sync[ValidatedNelUnit[ValidationError]], b: Sync[ValidatedNelUnit[ValidationError]]): Sync[ValidatedNelUnit[ValidationError]]

Combines a and b using AND. Short-circuits if ValidationResult.strategy is ValidationResult.Strategy.FailFast.

Combines a and b using AND. Short-circuits if ValidationResult.strategy is ValidationResult.Strategy.FailFast.

Inherited from:
ValidationModule
@inline
def assert[P](field: Field[P], cond: P => Boolean, error: Field[P] => ValidationError): Sync[ValidatedNelUnit[ValidationError]]

Returns ValidationResult.valid if cond is true else fails with provided error

Returns ValidationResult.valid if cond is true else fails with provided error

Inherited from:
ValidationModule
@inline
def assertF[P](field: Field[P], cond: P => Sync[Boolean], error: Field[P] => ValidationError): Sync[ValidatedNelUnit[ValidationError]]

Returns ValidationResult.valid if cond is true else fails with provided error

Returns ValidationResult.valid if cond is true else fails with provided error

Inherited from:
ValidationModule
@inline
def assertTrue[P](field: Field[P], cond: => Boolean, error: Field[P] => ValidationError): Sync[ValidatedNelUnit[ValidationError]]

Returns ValidationResult.valid if cond is true else fails with provided error

Returns ValidationResult.valid if cond is true else fails with provided error

Inherited from:
ValidationModule
@inline
def check[P](field: Field[P], f: Field[P] => ValidatedNelUnit[ValidationError]): Sync[ValidatedNelUnit[ValidationError]]

Applies f validation to Field#value

Applies f validation to Field#value

Inherited from:
ValidationModule
@inline
def checkF[P](field: Field[P], f: Field[P] => Sync[ValidatedNelUnit[ValidationError]]): Sync[ValidatedNelUnit[ValidationError]]

Applies f effectful validation to Field#value

Applies f effectful validation to Field#value

Inherited from:
ValidationModule
def combineAll(list: List[Sync[ValidatedNelUnit[ValidationError]]]): Sync[ValidatedNelUnit[ValidationError]]

Alias for and

Alias for and

Inherited from:
ValidationModule
@inline
def fold(list: List[Sync[ValidatedNelUnit[ValidationError]]], combine: (Sync[ValidatedNelUnit[ValidationError]], Sync[ValidatedNelUnit[ValidationError]]) => Sync[ValidatedNelUnit[ValidationError]]): Sync[ValidatedNelUnit[ValidationError]]

Combines all validations using combine function. This has minor optimistions that checks size to handle simple cases.

Combines all validations using combine function. This has minor optimistions that checks size to handle simple cases.

Inherited from:
ValidationModule
def or(list: List[Sync[ValidatedNelUnit[ValidationError]]]): Sync[ValidatedNelUnit[ValidationError]]

Combines all validations using OR

Combines all validations using OR

Inherited from:
ValidationModule
def or(a: Sync[ValidatedNelUnit[ValidationError]], b: Sync[ValidatedNelUnit[ValidationError]]): Sync[ValidatedNelUnit[ValidationError]]

Combines a and b using OR. Short-circuits if a is valid

Combines a and b using OR. Short-circuits if a is valid

Inherited from:
ValidationModule

Inherited fields

val valid: ValidatedNelUnit[ValidationError]

Valid VR[E] instance

Valid VR[E] instance

Inherited from:
ValidationModule
val validF: Sync[ValidatedNelUnit[ValidationError]]

Valid F[VR[E]] instance

Valid F[VR[E]] instance

Inherited from:
ValidationModule

Extensions

Inherited extensions

extension [P](builder: ValidationPolicyBuilder[P, F, VR, E])
inline def subRule[S](inline selector: P => S)(rules: Field[S] => Sync[ValidatedNelUnit[ValidationError]]*): ValidationPolicyBuilder[P, Sync, ValidatedNelUnit, ValidationError]

Adds new subrule to builder. Uses selector to create Field, rules are applied to that field

Adds new subrule to builder. Uses selector to create Field, rules are applied to that field

Inherited from:
PolicySyntax
inline def subRule2[S1, S2](inline selector1: P => S1, inline selector2: P => S2)(rules: (Field[S1], Field[S2]) => Sync[ValidatedNelUnit[ValidationError]]*): ValidationPolicyBuilder[P, Sync, ValidatedNelUnit, ValidationError]

Adds new subrule to builder. Same as subRule but for 2 subrules

Adds new subrule to builder. Same as subRule but for 2 subrules

Inherited from:
PolicySyntax
extension [P](field: Field[P])
def any(using II: IsIterable[P], M: ValidationModule[F, VR, E])(check: (Field[A], Int) => F[VR[E]]): Sync[ValidatedNelUnit[ValidationError]]

Applies check to each collection element, any should succeed

Applies check to each collection element, any should succeed

Inherited from:
IterableSyntax
def any(using II: IsIterable[P], M: ValidationModule[F, VR, E])(check: Field[A] => F[VR[E]]): Sync[ValidatedNelUnit[ValidationError]]

Applies check to each collection element, any should succeed

Applies check to each collection element, any should succeed

Inherited from:
IterableSyntax
def each(using II: IsIterable[P], M: ValidationModule[F, VR, E])(check: (Field[A], Int) => F[VR[E]]): Sync[ValidatedNelUnit[ValidationError]]

Applies check to each collection element, each should succeed

Applies check to each collection element, each should succeed

Inherited from:
IterableSyntax
def each(using II: IsIterable[P], M: ValidationModule[F, VR, E])(check: Field[A] => F[VR[E]]): Sync[ValidatedNelUnit[ValidationError]]

Applies check to each collection element, each should succeed

Applies check to each collection element, each should succeed

Inherited from:
IterableSyntax
def maxSize(using II: IsIterable[P], M: ValidationModule[F, VR, E])(max: Int)(using FailWithMaxSize[E]): Sync[ValidatedNelUnit[ValidationError]]

Checks that collection maximum size is max

Checks that collection maximum size is max

Inherited from:
IterableSyntax
def minSize(using II: IsIterable[P], M: ValidationModule[F, VR, E])(min: Int)(using FailWithMinSize[E]): Sync[ValidatedNelUnit[ValidationError]]

Checks that collection minimum size is min

Checks that collection minimum size is min

Inherited from:
IterableSyntax
def nonEmpty(using II: IsIterable[P], M: ValidationModule[F, VR, E])(using FailWithEmpty[E]): Sync[ValidatedNelUnit[ValidationError]]

Checks that collection is not empty

Checks that collection is not empty

Inherited from:
IterableSyntax
extension (field: Field.type)
inline def from[V](inline value: V): Field[V]

Returns Field that has provided value and infers its FieldPath from field selects

Returns Field that has provided value and infers its FieldPath from field selects

Example:

scala> val request = Request(User("ann"))
val request: Request = Request(User(ann))
scala> val field = Field.from(request.user.name)
val field: jap.fields.Field[String] = request.user.name:ann
Inherited from:
FieldSyntax
extension [P](field: Field[P])
inline def sub[S](inline selector: P => S): Field[S]

Returns subfield using selector function to extract value and as path

Returns subfield using selector function to extract value and as path

Example

scala> val request = Request(User("ann"))
scala> val field = Field.from(request)
val field: jap.fields.Field[Request] = request:Request(User(ann))
scala> field.sub(_.user.name)
val res1: jap.fields.Field[String] = request.user.name:ann
Inherited from:
FieldSyntax

Implicits

Inherited implicits

implicit val F: ValidationEffect[Sync]
Inherited from:
ValidationModule
implicit def Module: ValidationModule[Sync, ValidatedNelUnit, ValidationError]

Syntax classes requires implicit ValidationModule in scope

Syntax classes requires implicit ValidationModule in scope

Inherited from:
ValidationModule
implicit val VR: ValidationResult[ValidatedNelUnit]
Inherited from:
ValidationModule
final implicit def toBooleanFieldOps(field: Field[Boolean]): BooleanFieldOps[Sync, ValidatedNelUnit, ValidationError]
Inherited from:
BooleanSyntax
final implicit def toEffectValidationResultOps(a: Sync[ValidatedNelUnit[ValidationError]]): EffectValidationResultOps[Sync, ValidatedNelUnit, ValidationError]
Inherited from:
EffectValidationResultSyntax
final implicit def toEffectValidationResultSequenceOps(iterable: Iterable[Sync[ValidatedNelUnit[ValidationError]]]): EffectValidationResultSequenceOps[Sync, ValidatedNelUnit, ValidationError]
Inherited from:
EffectValidationResultSyntax
final implicit def toFailFieldOps[P](field: Field[P]): FailFieldOps[P, Sync, ValidatedNelUnit, ValidationError]
Inherited from:
FailSyntax
final implicit def toFieldOps[P](field: Field[P]): FieldOps[P, Sync, ValidatedNelUnit, ValidationError]
Inherited from:
GenericSyntax
final implicit def toMapFieldOps[K, V](field: Field[Map[K, V]]): MapFieldOps[K, V, Sync, ValidatedNelUnit, ValidationError]
Inherited from:
MapSyntax
final implicit def toNumericFieldOps[P](field: Field[P]): NumericFieldOps[P, Sync, ValidatedNelUnit, ValidationError]
Inherited from:
NumericSyntax
final implicit def toOptionFieldOps[P](field: Field[Option[P]]): OptionFieldOps[P, Sync, ValidatedNelUnit, ValidationError]
Inherited from:
OptionSyntax
final implicit def toStringFieldOps(field: Field[String]): StringFieldOps[Sync, ValidatedNelUnit, ValidationError]
Inherited from:
StringSyntax
final implicit def toValidationResultIdOps[E](error: E): ValidationResultIdOps[E]
Inherited from:
ValidationResultSyntax
final implicit def toValidationResultOps[VR[_] : ValidationResult, E](vr: VR[E]): ValidationResultOps[VR, E]
Inherited from:
ValidationResultSyntax