Serokell.Util.Verify

General-purpose utility functions

Documentation

data VerificationRes

Constructors

VerSuccess

VerFailure ![Text]

Instances

Eq VerificationRes

Methods

(==) :: VerificationRes -> VerificationRes -> Bool

(/=) :: VerificationRes -> VerificationRes -> Bool

Show VerificationRes

Methods

showsPrec :: Int -> VerificationRes -> ShowS

show :: VerificationRes -> String

showList :: [VerificationRes] -> ShowS

Semigroup VerificationRes

Methods

(<>) :: VerificationRes -> VerificationRes -> VerificationRes

sconcat :: NonEmpty VerificationRes -> VerificationRes

stimes :: Integral b => b -> VerificationRes -> VerificationRes

Monoid VerificationRes

Methods

mempty :: VerificationRes

mappend :: VerificationRes -> VerificationRes -> VerificationRes

mconcat :: [VerificationRes] -> VerificationRes

Helpers

isVerFailure :: VerificationRes -> Bool

isVerSuccess :: VerificationRes -> Bool

verResToMonadError :: MonadError e m => ([Text] -> e) -> VerificationRes -> m ()

Verification

verifyGeneric :: [(Bool, Text)] -> VerificationRes

This function takes list of (predicate, message) pairs and checks each predicate. If predicate is False it's considered an error. If there is at least one error this function returns VerFailure, otherwise VerSuccess is returned. It's useful to verify some data before using it. Example usage: `verifyGeneric [(checkA, "A is bad"), (checkB, "B is bad")]`

Prety printing

buildVerResFull :: VerificationRes -> Builder

Format VerificationRes in a pretty way using all errors messages for VerFailure.

buildVerResSingle :: VerificationRes -> Builder

Format VerificationRes in a pretty way using only first message for VerFailure.

formatAllErrors :: [Text] -> Text

Pretty printer for errors from VerFailure, all errors are printed.

formatFirstError :: [Text] -> Text

Pretty printer for errors from VerFailure, only first error is printed.

verResFullF :: Format r (VerificationRes -> r)

Formatter based on buildVerResFull.

verResSingleF :: Format r (VerificationRes -> r)

Formatter based on buildVerResSingle.