data-checked-0.3: Type-indexed runtime-checked properties

Safe HaskellSafe
LanguageHaskell98

Data.Checked

Description

Type-indexed runtime-checked properties.

Synopsis

Documentation

data Checked p v Source #

Wrapper-evidence for property p.

Instances
NFData v => NFData (Checked p v) Source # 
Instance details

Defined in Data.Checked

Methods

rnf :: Checked p v -> () #

trustMe :: v -> Checked p v Source #

Use when the property can be deduced without a runtime check.

trustThat :: p -> v -> Checked p v Source #

Use when the property can be deduced without a runtime check.

trustMap :: (v -> v) -> Checked p v -> Checked p v Source #

Apply a fuction that preserves the property to the checked value.

checked :: Checked p v -> v Source #

Unwrap the checked value.

class Property p v where Source #

Methods

holds :: p -> v -> Bool Source #

Test if the property holds for the given value. The first argument is supposed to be ignored.

maybeHolds :: Property p v => p -> v -> Maybe v Source #

Return Just v if p holds and Nothing overwise.

check :: forall p v. Property p v => v -> Maybe (Checked p v) Source #

Wrap the value if the property holds.