Documentation

Adds a plain-text validation error to a record

Example:

>>> record |> attachFailure #email "should be a valid email"
User { .., meta = MetaBag { .., annotations = [ ("email", TextViolation "should be a valid email") ] } }

You can use this together with getValidationFailure

user
    |> attachFailure #email "cannot be empty"
    |> getValidationFailure #email

--  Returns: Just "cannot be empty"

If your error message uses HTML code, use attachFailureHtml.

Adds a validation error to a record. The error message can contain HTML code.

Example:

>>> record |> attachFailureHtml #email [hsx|should be a valid email. <a href="https://example.com/docs#email">Check out the documentation</a>|]
User { .., meta = MetaBag { .., annotations = [ ("email", HtmlViolation "should be a valid email. <a href="https://example.com/docs#email">Check out the documentation</a>") ] } }

You can use this together with getValidationViolation

user
    |> attachFailure #email "cannot be empty"
    |> getValidationViolation #email

--  Returns: Just (HtmlViolation "should be a valid email. <a href="https://example.com/docs#email">Check out the documentation</a>")

Returns the validation failure for a field or Nothing

user
    |> attachFailure #email "cannot be empty"
    |> getValidationFailure #email

--  Returns: Just "cannot be empty"

When attachFailureHtml is used, this function will return HTML code:

user
    |> attachFailureHtml #url [hsx|Invalid value, check <a href="https://example.com">the documentation</a>|]
    |> getValidationFailure #url

--  Returns: Just "Invalid value, check <a href="https://example.com">the documentation</a>"

If you need to special-case validation errors with HTML code, use getValidationViolation

Similar to getValidationFailure, but exposes the information whether the error message contains HTML code

>>> user |> getValidationViolation #email
Just (TextViolation "cannot be empty")