Strongweak.Strengthen

Strengthen class

class Weaken a => Strengthen a where

Attempt to strengthen some Weak a, asserting certain invariants.

We take Weaken as a superclass in order to maintain strong/weak type pair consistency. We choose this dependency direction because we treat the strong type as the "canonical" one, so Weaken is the more natural (and straightforward) class to define. That does mean the instances for this class are a little confusingly worded. Alas.

See Strongweak for class design notes and laws.

Methods

strengthen :: Weak a -> Validation (NonEmpty StrengthenFail) a

Attempt to strengthen some Weak a to its associated strong type a.

Instances

Strengthen Int16

Defined in Strongweak.Strengthen

Methods

strengthen :: Weak Int16 -> Validation (NonEmpty StrengthenFail) Int16

Strengthen Int32

Defined in Strongweak.Strengthen

Methods

strengthen :: Weak Int32 -> Validation (NonEmpty StrengthenFail) Int32

Strengthen Int64

Defined in Strongweak.Strengthen

Methods

strengthen :: Weak Int64 -> Validation (NonEmpty StrengthenFail) Int64

Strengthen Int8

Defined in Strongweak.Strengthen

Methods

strengthen :: Weak Int8 -> Validation (NonEmpty StrengthenFail) Int8

Strengthen Word16

Defined in Strongweak.Strengthen

Methods

strengthen :: Weak Word16 -> Validation (NonEmpty StrengthenFail) Word16

Strengthen Word32

Defined in Strongweak.Strengthen

Methods

strengthen :: Weak Word32 -> Validation (NonEmpty StrengthenFail) Word32

Strengthen Word64

Defined in Strongweak.Strengthen

Methods

strengthen :: Weak Word64 -> Validation (NonEmpty StrengthenFail) Word64

Strengthen Word8

Defined in Strongweak.Strengthen

Methods

strengthen :: Weak Word8 -> Validation (NonEmpty StrengthenFail) Word8

Strengthen (Identity a)

Add wrapper.

Defined in Strongweak.Strengthen

Methods

strengthen :: Weak (Identity a) -> Validation (NonEmpty StrengthenFail) (Identity a)

(Typeable a, Show a) => Strengthen (NonEmpty a)

Strengthen a plain list into a non-empty list by asserting non-emptiness.

Defined in Strongweak.Strengthen

Methods

strengthen :: Weak (NonEmpty a) -> Validation (NonEmpty StrengthenFail) (NonEmpty a)

Strengthen a => Strengthen [a]

Decomposer. Strengthen every element in a list.

Defined in Strongweak.Strengthen

Methods

strengthen :: Weak [a] -> Validation (NonEmpty StrengthenFail) [a]

(Strengthen a, Strengthen b) => Strengthen (Either a b)

Decomposer. Strengthen either side of an Either.

Defined in Strongweak.Strengthen

Methods

strengthen :: Weak (Either a b) -> Validation (NonEmpty StrengthenFail) (Either a b)

(Generic s, Generic w, GStrengthenD (Rep w) (Rep s), Weaken (GenericallySW s w)) => Strengthen (GenericallySW s w)

Defined in Strongweak.Generic.Via

Methods

strengthen :: Weak (GenericallySW s w) -> Validation (NonEmpty StrengthenFail) (GenericallySW s w)

(Strengthen a, Strengthen b) => Strengthen (a, b)

Decomposer. Strengthen both elements of a tuple.

Defined in Strongweak.Strengthen

Methods

strengthen :: Weak (a, b) -> Validation (NonEmpty StrengthenFail) (a, b)

Strengthen (Const a b)

Add wrapper.

Defined in Strongweak.Strengthen

Methods

strengthen :: Weak (Const a b) -> Validation (NonEmpty StrengthenFail) (Const a b)

(Predicate p a, Typeable k, Typeable a, Show a) => Strengthen (Refined p a)

Assert a predicate to refine a type.

Defined in Strongweak.Strengthen

Methods

strengthen :: Weak (Refined p a) -> Validation (NonEmpty StrengthenFail) (Refined p a)

(Vector v a, KnownNat n, Typeable v, Typeable a, Show a) => Strengthen (Vector v n a)

Strengthen a plain list into a sized vector by asserting length.

Defined in Strongweak.Strengthen

Methods

strengthen :: Weak (Vector v n a) -> Validation (NonEmpty StrengthenFail) (Vector v n a)

Strengthen failures

data StrengthenFail

Strengthen failure data type. Don't use these constructors directly, use the existing helper functions.

Field indices are from 0 in the respective constructor. Field names are provided if present.

Constructors

StrengthenFailBase

Fields

• String

  weak type

• String

  strong type

• String

  weak value

• String

  msg

StrengthenFailField

Fields

• String

  weak datatype name

• String

  strong datatype name

• String

  weak constructor name

• String

  strong constructor name

• Natural

  weak field index

• (Maybe String)

  weak field name (if present)

• Natural

  strong field index

• (Maybe String)

  strong field name (if present)

• (NonEmpty StrengthenFail)

  failures

Instances

Show StrengthenFail

Defined in Strongweak.Strengthen

Methods

showsPrec :: Int -> StrengthenFail -> ShowS

show :: StrengthenFail -> String

showList :: [StrengthenFail] -> ShowS

Eq StrengthenFail

Defined in Strongweak.Strengthen

Methods

(==) :: StrengthenFail -> StrengthenFail -> Bool

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

Pretty StrengthenFail

Defined in Strongweak.Strengthen

Methods

pretty :: StrengthenFail -> Doc ann

prettyList :: [StrengthenFail] -> Doc ann

strengthenFailPretty :: NonEmpty StrengthenFail -> Doc a

strengthenFailBase :: forall s w. (Typeable w, Show w, Typeable s) => w -> String -> Validation (NonEmpty StrengthenFail) s

Restrengthening

restrengthen :: (Strengthen a, Weaken a) => a -> Validation (NonEmpty StrengthenFail) a

Weaken a strong value, then strengthen it again.

Potentially useful if you have previously used unsafeStrengthen and now wish to check the invariants. For example:

>>> restrengthen $ unsafeStrengthen @(Vector 2 Natural) [0]
Failure ...

Helpers

strengthenBounded :: forall b n. (Integral b, Bounded b, Show b, Typeable b, Integral n, Show n, Typeable n) => n -> Validation (NonEmpty StrengthenFail) b

Re-exports

type family Weak a :: Type

The weakened type for some type.

Instances

type Weak Int16

Defined in Strongweak.Weaken

type Weak Int16 = Integer

type Weak Int32

Defined in Strongweak.Weaken

type Weak Int32 = Integer

type Weak Int64

Defined in Strongweak.Weaken

type Weak Int64 = Integer

type Weak Int8

Defined in Strongweak.Weaken

type Weak Int8 = Integer

type Weak Word16

Defined in Strongweak.Weaken

type Weak Word16 = Natural

type Weak Word32

Defined in Strongweak.Weaken

type Weak Word32 = Natural

type Weak Word64

Defined in Strongweak.Weaken

type Weak Word64 = Natural

type Weak Word8

Defined in Strongweak.Weaken

type Weak Word8 = Natural

type Weak (Identity a)

Defined in Strongweak.Weaken

type Weak (Identity a) = a

type Weak (NonEmpty a)

Defined in Strongweak.Weaken

type Weak (NonEmpty a) = [a]

type Weak [a]

Defined in Strongweak.Weaken

type Weak [a] = [Weak a]

type Weak (Either a b)

Defined in Strongweak.Weaken

type Weak (Either a b) = Either (Weak a) (Weak b)

type Weak (GenericallySW s w)

Defined in Strongweak.Generic.Via

type Weak (GenericallySW s w) = w

type Weak (a, b)

Defined in Strongweak.Weaken

type Weak (a, b) = (Weak a, Weak b)

type Weak (Const a b)

Defined in Strongweak.Weaken

type Weak (Const a b) = a

type Weak (Refined p a)

Defined in Strongweak.Weaken

type Weak (Refined p a) = a

type Weak (Vector v n a)

Defined in Strongweak.Weaken

type Weak (Vector v n a) = [a]