Data.Convert.Class

Documentation

class Convertible t t' where

Convertible allows for conversion between two compatible types. When trying to convert between the same types, compile time error is reported in order to help tracking not needed usages. If you want to enable conversion between the same types, use convert' instead.

Minimal complete definition

convert

Methods

convert :: t -> t'

Instances

TypeError Constraint (IdConversionErr * t) => Convertible t t

Methods

convert :: t -> t

Convertible1 * t t' => Convertible (t a) (t' a)

Methods

convert :: t a -> t' a

(Convertible1 * t t', Convertible' a a', Functor t') => Convertible (t a) (t' a')

Methods

convert :: t a -> t' a'

(Convertible a a', Functor t) => Convertible (t a) (t a')

We cannot use OVERLAPPABLE instances here. Let's consider following instance: instance (s ~ s', t ~ t') => Convertible (Symbol s t) (Symbol2 s' t') where ... By writing it we indicate that during conversion from Symbol to Symbol2 the appropriate variables should be matched. If the following instances would be declared as OVERLAPPABLE, it will clash with the instance `Convertible (t a) (t' a)`. In other words, if user defines any conversion between type `X a` and `Y b`, we disable automatic lifting to ConvertibleN. TODO[WD]: File GHC proposal to choose more specific incoherent instance

Methods

convert :: t a -> t a'

class Convertible1 t t' where

Minimal complete definition

convert1

Methods

convert1 :: forall s1. t s1 -> t' s1

Instances

TypeError Constraint (IdConversionErr (k -> *) t) => Convertible1 k t t

Methods

convert1 :: t s1 -> t' s1

Convertible2 k1 k2 t t' => Convertible1 k2 (t a) (t' a)

Methods

convert1 :: t' a s1 -> t' s1

class Convertible2 t t' where

Minimal complete definition

convert2

Methods

convert2 :: forall s1 s2. t s1 s2 -> t' s1 s2

Instances

TypeError Constraint (IdConversionErr (k1 -> k2 -> *) t) => Convertible2 k1 k2 t t

Methods

convert2 :: t s1 s2 -> t' s1 s2

Convertible3 k1 k2 k3 t t' => Convertible2 k2 k3 (t a) (t' a)

Methods

convert2 :: t s1 s2 -> t' s1 s2

class Convertible3 t t' where

Minimal complete definition

convert3

Methods

convert3 :: forall s1 s2 s3. t s1 s2 s3 -> t' s1 s2 s3

Instances

TypeError Constraint (IdConversionErr (k1 -> k2 -> k3 -> *) t) => Convertible3 k1 k2 k3 t t

Methods

convert3 :: t s1 s2 s3 -> t' s1 s2 s3

Convertible4 k1 k2 k3 k4 t t' => Convertible3 k2 k3 k4 (t a) (t' a)

Methods

convert3 :: t s1 s2 s3 -> t' s1 s2 s3

class Convertible4 t t' where

Minimal complete definition

convert4

Methods

convert4 :: forall s1 s2 s3 s4. t s1 s2 s3 s4 -> t' s1 s2 s3 s4

Instances

TypeError Constraint (IdConversionErr (k1 -> k2 -> k3 -> k4 -> *) t) => Convertible4 k1 k2 k3 k4 t t

Methods

convert4 :: t s1 s2 s3 s4 -> t' s1 s2 s3 s4

Convertible5 k1 k2 k3 k4 k5 t t' => Convertible4 k2 k3 k4 k5 (t a) (t' a)

Methods

convert4 :: t s1 s2 s3 s4 -> t' s1 s2 s3 s4

class Convertible5 t t' where

Minimal complete definition

convert5

Methods

convert5 :: forall s1 s2 s3 s4 s5. t s1 s2 s3 s4 s5 -> t' s1 s2 s3 s4 s5

Instances

TypeError Constraint (IdConversionErr (k1 -> k2 -> k3 -> k4 -> k5 -> *) t) => Convertible5 k1 k2 k3 k4 k5 t t

Methods

convert5 :: t s1 s2 s3 s4 s5 -> t' s1 s2 s3 s4 s5

type IdConversionErr (t :: k) = (Text "Conversion of the same type (`" :<>: ShowType t) :<>: Text "`) is disabled by default. Please use convert' if you want to enable it."

convertTo :: forall t' t. Convertible t t' => t -> t'

convertTo1 :: forall t' t. Convertible1 t t' => forall s1. t s1 -> t' s1

convertTo2 :: forall t' t. Convertible2 t t' => forall s1 s2. t s1 s2 -> t' s1 s2

convertTo3 :: forall t' t. Convertible3 t t' => forall s1 s2 s3. t s1 s2 s3 -> t' s1 s2 s3

convertTo4 :: forall t' t. Convertible4 t t' => forall s1 s2 s3 s4. t s1 s2 s3 s4 -> t' s1 s2 s3 s4

convertTo5 :: forall t' t. Convertible5 t t' => forall s1 s2 s3 s4 s5. t s1 s2 s3 s4 s5 -> t' s1 s2 s3 s4 s5

class Convertible' t t' where

Minimal complete definition

convert'

Methods

convert' :: t -> t'

Instances

Convertible t t' => Convertible' t t'

Methods

convert' :: t -> t'

Convertible' t t

Methods

convert' :: t -> t

class Convertible1' t t' where

Minimal complete definition

convert1'

Methods

convert1' :: forall s1. t s1 -> t' s1

Instances

Convertible1 k t t' => Convertible1' k t t'

Methods

convert1' :: t' s1 -> t' s1

Convertible1' k t t

Methods

convert1' :: t s1 -> t' s1

class Convertible2' t t' where

Minimal complete definition

convert2'

Methods

convert2' :: forall s1 s2. t s1 s2 -> t' s1 s2

Instances

Convertible2 k1 k2 t t' => Convertible2' k1 k2 t t'

Methods

convert2' :: t s1 s2 -> t' s1 s2

Convertible2' k1 k2 t t

Methods

convert2' :: t s1 s2 -> t' s1 s2

class Convertible3' t t' where

Minimal complete definition

convert3'

Methods

convert3' :: forall s1 s2 s3. t s1 s2 s3 -> t' s1 s2 s3

Instances

Convertible3 k1 k2 k3 t t' => Convertible3' k1 k2 k3 t t'

Methods

convert3' :: t s1 s2 s3 -> t' s1 s2 s3

Convertible3' k1 k2 k3 t t

Methods

convert3' :: t s1 s2 s3 -> t' s1 s2 s3

class Convertible4' t t' where

Minimal complete definition

convert4'

Methods

convert4' :: forall s1 s2 s3 s4. t s1 s2 s3 s4 -> t' s1 s2 s3 s4

Instances

Convertible4 k1 k2 k3 k4 t t' => Convertible4' k1 k2 k3 k4 t t'

Methods

convert4' :: t s1 s2 s3 s4 -> t' s1 s2 s3 s4

Convertible4' k1 k2 k3 k4 t t

Methods

convert4' :: t s1 s2 s3 s4 -> t' s1 s2 s3 s4

class Convertible5' t t' where

Minimal complete definition

convert5'

Methods

convert5' :: forall s1 s2 s3 s4 s5. t s1 s2 s3 s4 s5 -> t' s1 s2 s3 s4 s5

Instances

Convertible5 k1 k2 k3 k4 k5 t t' => Convertible5' k1 k2 k3 k4 k5 t t'

Methods

convert5' :: t s1 s2 s3 s4 s5 -> t' s1 s2 s3 s4 s5

Convertible5' k1 k2 k3 k4 k5 t t

Methods

convert5' :: t s1 s2 s3 s4 s5 -> t' s1 s2 s3 s4 s5

convertTo' :: forall t' t. Convertible' t t' => t -> t'

convertTo1' :: forall t' t. Convertible1' t t' => forall s1. t s1 -> t' s1

convertTo2' :: forall t' t. Convertible2' t t' => forall s1 s2. t s1 s2 -> t' s1 s2

convertTo3' :: forall t' t. Convertible3' t t' => forall s1 s2 s3. t s1 s2 s3 -> t' s1 s2 s3

convertTo4' :: forall t' t. Convertible4' t t' => forall s1 s2 s3 s4. t s1 s2 s3 s4 -> t' s1 s2 s3 s4

convertTo5' :: forall t' t. Convertible5' t t' => forall s1 s2 s3 s4 s5. t s1 s2 s3 s4 s5 -> t' s1 s2 s3 s4 s5

data SimpleConversionError

Constructors

SimpleConversionError

Instances

Show SimpleConversionError

Methods

showsPrec :: Int -> SimpleConversionError -> ShowS

show :: SimpleConversionError -> String

showList :: [SimpleConversionError] -> ShowS

Default SimpleConversionError

Methods

def :: SimpleConversionError

class PartialConvertible t t' where

PartialConvertible allows conversions that could fail with ConversionError.

Minimal complete definition

convertAssert, unsafeConvert

Associated Types

type ConversionError t t'

Methods

convertAssert :: t -> Maybe (ConversionError t t')

unsafeConvert :: t -> t'

defConvertAssert :: Default e => (a -> Bool) -> a -> Maybe e

unsafeConvertTo :: forall t' t. PartialConvertible t t' => t -> t'

convertAssertTo :: forall t' t. PartialConvertible t t' => t -> Maybe (ConversionError t t')

maybeConvert :: forall t t'. PartialConvertible t t' => t -> Maybe t'

tryConvert :: forall t t'. PartialConvertible t t' => t -> Either (ConversionError t t') t'

type BiConvertible t t' = (Convertible t t', Convertible t' t)

type BiConvertible1 t t' = (Convertible1 t t', Convertible1 t' t)

type BiConvertible2 t t' = (Convertible2 t t', Convertible2 t' t)

type BiConvertible3 t t' = (Convertible3 t t', Convertible3 t' t)

type BiConvertible4 t t' = (Convertible4 t t', Convertible4 t' t)

type BiConvertible5 t t' = (Convertible5 t t', Convertible5 t' t)

type BiConvertible' t t' = (Convertible' t t', Convertible' t' t)

type BiConvertible1' t t' = (Convertible1' t t', Convertible1' t' t)

type BiConvertible2' t t' = (Convertible2' t t', Convertible2' t' t)

type BiConvertible3' t t' = (Convertible3' t t', Convertible3' t' t)

type BiConvertible4' t t' = (Convertible4' t t', Convertible4' t' t)

type BiConvertible5' t t' = (Convertible5' t t', Convertible5' t' t)

type BiPartialConvertible t t' = (PartialConvertible t t', PartialConvertible t t')

converted :: BiConvertible t t' => Iso' t t'

converted1 :: BiConvertible1 t t' => forall s1. Iso' (t s1) (t' s1)

converted2 :: BiConvertible2 t t' => forall s1 s2. Iso' (t s1 s2) (t' s1 s2)

converted3 :: BiConvertible3 t t' => forall s1 s2 s3. Iso' (t s1 s2 s3) (t' s1 s2 s3)

converted4 :: BiConvertible4 t t' => forall s1 s2 s3 s4. Iso' (t s1 s2 s3 s4) (t' s1 s2 s3 s4)

converted5 :: BiConvertible5 t t' => forall s1 s2 s3 s4 s5. Iso' (t s1 s2 s3 s4 s5) (t' s1 s2 s3 s4 s5)

converted' :: BiConvertible' t t' => Iso' t t'

converted1' :: BiConvertible1' t t' => forall s1. Iso' (t s1) (t' s1)

converted2' :: BiConvertible2' t t' => forall s1 s2. Iso' (t s1 s2) (t' s1 s2)

converted3' :: BiConvertible3' t t' => forall s1 s2 s3. Iso' (t s1 s2 s3) (t' s1 s2 s3)

converted4' :: BiConvertible4' t t' => forall s1 s2 s3 s4. Iso' (t s1 s2 s3 s4) (t' s1 s2 s3 s4)

converted5' :: BiConvertible5' t t' => forall s1 s2 s3 s4 s5. Iso' (t s1 s2 s3 s4 s5) (t' s1 s2 s3 s4 s5)

convertedTo :: BiConvertible t' t => Iso' t t'

convertedTo1 :: BiConvertible1 t' t => forall s1. Iso' (t s1) (t' s1)

convertedTo2 :: BiConvertible2 t' t => forall s1 s2. Iso' (t s1 s2) (t' s1 s2)

convertedTo3 :: BiConvertible3 t' t => forall s1 s2 s3. Iso' (t s1 s2 s3) (t' s1 s2 s3)

convertedTo4 :: BiConvertible4 t' t => forall s1 s2 s3 s4. Iso' (t s1 s2 s3 s4) (t' s1 s2 s3 s4)

convertedTo5 :: BiConvertible5 t' t => forall s1 s2 s3 s4 s5. Iso' (t s1 s2 s3 s4 s5) (t' s1 s2 s3 s4 s5)

convertedTo' :: BiConvertible' t' t => Iso' t t'

convertedTo1' :: BiConvertible1' t' t => forall s1. Iso' (t s1) (t' s1)

convertedTo2' :: BiConvertible2' t' t => forall s1 s2. Iso' (t s1 s2) (t' s1 s2)

convertedTo3' :: BiConvertible3' t' t => forall s1 s2 s3. Iso' (t s1 s2 s3) (t' s1 s2 s3)

convertedTo4' :: BiConvertible4' t' t => forall s1 s2 s3 s4. Iso' (t s1 s2 s3 s4) (t' s1 s2 s3 s4)

convertedTo5' :: BiConvertible5' t' t => forall s1 s2 s3 s4 s5. Iso' (t s1 s2 s3 s4 s5) (t' s1 s2 s3 s4 s5)

type ConvertibleVia t p t' = (Convertible t p, Convertible p t')

type ConvertibleVia1 t p t' = (Convertible1 t p, Convertible1 p t')

type ConvertibleVia2 t p t' = (Convertible2 t p, Convertible2 p t')

type ConvertibleVia3 t p t' = (Convertible3 t p, Convertible3 p t')

type ConvertibleVia4 t p t' = (Convertible4 t p, Convertible4 p t')

type ConvertibleVia5 t p t' = (Convertible5 t p, Convertible5 p t')

convertVia :: forall p t t'. ConvertibleVia t p t' => t -> t'

convertVia1 :: forall p t t'. ConvertibleVia1 t p t' => forall s1. t s1 -> t' s1

convertVia2 :: forall p t t'. ConvertibleVia2 t p t' => forall s1 s2. t s1 s2 -> t' s1 s2

convertVia3 :: forall p t t'. ConvertibleVia3 t p t' => forall s1 s2 s3. t s1 s2 s3 -> t' s1 s2 s3

convertVia4 :: forall p t t'. ConvertibleVia4 t p t' => forall s1 s2 s3 s4. t s1 s2 s3 s4 -> t' s1 s2 s3 s4

convertVia5 :: forall p t t'. ConvertibleVia5 t p t' => forall s1 s2 s3 s4 s5. t s1 s2 s3 s4 s5 -> t' s1 s2 s3 s4 s5

type ConvertibleVia' t p t' = (Convertible' t p, Convertible' p t')

type ConvertibleVia1' t p t' = (Convertible1' t p, Convertible1' p t')

type ConvertibleVia2' t p t' = (Convertible2' t p, Convertible2' p t')

type ConvertibleVia3' t p t' = (Convertible3' t p, Convertible3' p t')

type ConvertibleVia4' t p t' = (Convertible4' t p, Convertible4' p t')

type ConvertibleVia5' t p t' = (Convertible5' t p, Convertible5' p t')

convertVia' :: forall p t t'. ConvertibleVia' t p t' => t -> t'

convertVia1' :: forall p t t'. ConvertibleVia1' t p t' => forall s1. t s1 -> t' s1

convertVia2' :: forall p t t'. ConvertibleVia2' t p t' => forall s1 s2. t s1 s2 -> t' s1 s2

convertVia3' :: forall p t t'. ConvertibleVia3' t p t' => forall s1 s2 s3. t s1 s2 s3 -> t' s1 s2 s3

convertVia4' :: forall p t t'. ConvertibleVia4' t p t' => forall s1 s2 s3 s4. t s1 s2 s3 s4 -> t' s1 s2 s3 s4

convertVia5' :: forall p t t'. ConvertibleVia5' t p t' => forall s1 s2 s3 s4 s5. t s1 s2 s3 s4 s5 -> t' s1 s2 s3 s4 s5

type PartialConvertibleVia t p t' = (PartialConvertible t p, PartialConvertible p t')

unsafeConvertVia :: forall p t t'. PartialConvertibleVia t p t' => t -> t'