Validator Class Reference


                    
                    
                    init()

Initializes a new instance.

Declaration

Swift

public init()


                    
                    
                    validate(_:against:on:)

Validates a primitive Encodable value against an array of Constraints on a set of Groups.

Throws

A Validator.Error if the value is not of primitive type or a ConstraintViolation if the value doesn’t satisfy Constraints on Groups.

Declaration

Swift

public func validate(
    _ value: Encodable?,
    against constraints: [Constraint],
    on groups: Set<Group> = .init()
) throws

Parameters

`value`	A primitive `Encodable` value to be validated.
`constraints`	An array of `Constraint`s.
`groups`	A set of `Group`s to run validations for. Defaults to an empty set.


                    
                    
                    validate(_:against:on:)

Validates a primitive Encodable value against a variadic list of Constraints on a set of Groups.

Throws

A Validator.Error if the value is not of primitive type or a ConstraintViolation if the value doesn’t satisfy Constraints on Groups.

Declaration

Swift

public func validate(
    _ value: Encodable?,
    against constraints: Constraint...,
    on groups: Set<Group> = .init()
) throws

Parameters

`value`	A primitive `Encodable` value to be validated.
`constraints`	A variadic list of `Constraint`s.
`groups`	A set of `Group`s to run validations for. Defaults to an empty set.


                    
                    
                    validate(_:against:on:)

Validates a primitive Encodable value against an array of ConstraintTypes on a set of Groups.

Throws

A Validator.Error if the value is not of primitive type or a ConstraintViolation if the value doesn’t satisfy Constraints on Groups.

Declaration

Swift

public func validate(
    _ value: Encodable?,
    against constraintTypes: [ConstraintType],
    on groups: Set<Group> = .init()
) throws

Parameters

`value`	A primitive `Encodable` value to be validated.
`constraintTypes`	An array of `ConstraintType`s.
`groups`	A set of `Group`s to run validations for. Defaults to an empty set.


                    
                    
                    validate(_:against:on:with:)

Validates a complex Encodable value against a DictionaryCollection<String, Constraint> on a set of Groups with a list of Validator.Options.

Throws

A Validator.Error if it can’t decode the encoded value.

Declaration

Swift

public func validate(
    _ value: Encodable?,
    against constraintCollection: DictionaryCollection<String, Constraint>,
    on groups: Set<Group> = .init(),
    with options: Options = .init()
) throws -> DictionaryCollection<String, ConstraintViolation>

Parameters

`value`	A complex `Encodable` value to be validated.
`constraintCollection`	A `DictionaryCollection<String, Constraint>`.
`groups`	A set of `Group`s to run validations for. Defaults to an empty set.
`options`	A list of `Validator.Options`. Defaults to an empty array.

Return Value

A DictionaryCollection<String, ConstraintViolation>.


                    
                    
                    validate(_:against:on:with:)

Validates a complex Encodable value against a DictionaryCollection<String, Constraint> on a GroupSequence with a list of Validator.Options.

Throws

A Validator.Error if it can’t decode the encoded value.

Declaration

Swift

public func validate(
    _ value: Encodable?,
    against constraintCollection: DictionaryCollection<String, Constraint>,
    on groupSequence: GroupSequence,
    with options: Options = .init()
) throws -> DictionaryCollection<String, ConstraintViolation>

Parameters

`value`	A complex `Encodable` value to be validated.
`constraintCollection`	A `DictionaryCollection<String, Constraint>`.
`groupSequence`	A list of groups.
`options`	A list of `Validator.Options`. Defaults to an empty array.

Return Value

A DictionaryCollection<String, ConstraintViolation>.


                    
                    
                    Error

A common error type thrown when an invalid Constraint type is provided to the validate(_:against:) method of the ConstraintValidator.

Declaration

Swift

public enum Error : LocalizedError


                    
                    
                    Options

A list of OptionSet to manage the behavior of Validator.

Declaration

Swift

public struct Options : OptionSet