diff --git a/src/lib/Witch.hs b/src/lib/Witch.hs index f440d89..3741c78 100644 --- a/src/lib/Witch.hs +++ b/src/lib/Witch.hs @@ -6,14 +6,13 @@ -- >>> import Witch -- -- In typical usage, you will most likely use 'Witch.Utility.into' for --- 'Witch.Cast.Cast' instances and 'With.Utility.tryInto' for +-- 'Witch.From.From' instances and 'With.Utility.tryInto' for -- 'Witch.TryCast.TryCast' instances. module Witch ( -- * Type classes - -- ** Cast - Witch.Cast.Cast(cast) - , Witch.Utility.from + -- ** From + Witch.From.From(from) , Witch.Utility.into -- ** TryCast @@ -34,7 +33,7 @@ module Witch -- a conversion is safe even though you can't prove it to the compiler, and -- when you're alright with your program crashing if the conversion fails. -- In all other cases you should prefer the normal conversion functions like - -- 'Witch.Cast.cast'. And if you're converting a literal value, consider + -- 'Witch.From.from'. And if you're converting a literal value, consider -- using the Template Haskell conversion functions like -- 'Witch.Lift.liftedCast'. , Witch.Utility.unsafeCast @@ -65,7 +64,7 @@ module Witch -- pitfalls to watch out for. -- -- This library tries to address that problem by providing a common - -- interface for converting between types. The 'Witch.Cast.Cast' type class + -- interface for converting between types. The 'Witch.From.From' type class -- is for conversions that cannot fail, and the 'Witch.TryCast.TryCast' type -- class is for conversions that can fail. These type classes are inspired -- by the [@From@](https://doc.rust-lang.org/std/convert/trait.From.html) @@ -120,7 +119,7 @@ module Witch -- negative 'Int' into a 'Word' will overflow, which may be surprising. -- ** Instances - -- | When should you add a 'Witch.Cast.Cast' (or 'Witch.TryCast.TryCast') + -- | When should you add a 'Witch.From.From' (or 'Witch.TryCast.TryCast') -- instance for some pair of types? This is a surprisingly tricky question -- to answer precisely. Instances are driven more by guidelines than rules. -- @@ -129,39 +128,39 @@ module Witch -- -- - Conversions should be unambiguous. If there are multiple reasonable -- ways to convert from @a@ to @b@, then you probably should not add a - -- @Cast@ instance for them. + -- 'Witch.From.From' instance for them. -- - -- - Conversions should be lossless. If you have @Cast a b@ then no two @a@ + -- - Conversions should be lossless. If you have @From a b@ then no two @a@ -- values should be converted to the same @b@ value. -- -- - Some conversions necessarily lose information, like converting from a -- list into a set. -- - -- - If you have both @Cast a b@ and @Cast b a@, then - -- @cast \@b \@a . cast \@a \@b@ should be the same as 'id'. In other + -- - If you have both @From a b@ and @From b a@, then + -- @from \@b \@a . from \@a \@b@ should be the same as 'id'. In other -- words, @a@ and @b@ are isomorphic. -- -- - This often true, but not always. For example, converting a list into -- a set will remove duplicates. And then converting back into a list -- will put the elements in ascending order. -- - -- - If you have both @Cast a b@ and @Cast b c@, then you could also have - -- @Cast a c@ and it should be the same as @cast \@b \@c . cast \@a \@b@. - -- In other words, @Cast@ is transitive. + -- - If you have both @From a b@ and @From b c@, then you could also have + -- @From a c@ and it should be the same as @from \@b \@c . from \@a \@b@. + -- In other words, @From@ is transitive. -- -- - This is not always true. For example an @Int8@ may be represented as -- a number in JSON, whereas an @Int64@ might be represented as a -- string. That means @into \@JSON (into \@Int64 int8)@ would not be the -- same as @into \@JSON int8@. -- - -- In general if @s@ /is/ a @t@, then you should add a 'Witch.Cast.Cast' + -- In general if @s@ /is/ a @t@, then you should add a 'Witch.From.From' -- instance for it. But if @s@ merely /can be/ a @t@, then you could add a -- 'Witch.TryCast.TryCast' instance for it. And if it is technically -- possible to convert from @s@ to @t@ but there are a lot of caveats, you -- probably should not write any instances at all. ) where -import qualified Witch.Cast +import qualified Witch.From import Witch.Instances () import qualified Witch.Lift import qualified Witch.TryCast diff --git a/src/lib/Witch/Cast.hs b/src/lib/Witch/From.hs similarity index 74% rename from src/lib/Witch/Cast.hs rename to src/lib/Witch/From.hs index e3aeafa..20798ce 100644 --- a/src/lib/Witch/Cast.hs +++ b/src/lib/Witch/From.hs @@ -1,18 +1,18 @@ {-# LANGUAGE DefaultSignatures #-} {-# LANGUAGE MultiParamTypeClasses #-} -module Witch.Cast where +module Witch.From where import qualified Data.Coerce as Coerce -- | This type class is for converting values from some @source@ type into --- some other @target@ type. The constraint @Cast source target@ measn that +-- some other @target@ type. The constraint @From source target@ measn that -- you can convert from a value of type @source@ into a value of type -- @target@. -- -- This type class is for conversions that cannot fail. If your conversion can -- fail, consider implementing @TryCast@ instead. -class Cast source target where +class From source target where -- | This method implements the conversion of a value between types. At call -- sites you will usually want to use @from@ or @into@ instead of this -- method. @@ -23,9 +23,9 @@ class Cast source target where -- all. For example: -- -- >>> newtype Name = Name String - -- >>> instance Cast Name String - -- >>> instance Cast String Name - cast :: source -> target + -- >>> instance From Name String + -- >>> instance From String Name + from :: source -> target - default cast :: Coerce.Coercible source target => source -> target - cast = Coerce.coerce + default from :: Coerce.Coercible source target => source -> target + from = Coerce.coerce diff --git a/src/lib/Witch/Instances.hs b/src/lib/Witch/Instances.hs index 876a5ea..1b6208b 100644 --- a/src/lib/Witch/Instances.hs +++ b/src/lib/Witch/Instances.hs @@ -29,7 +29,7 @@ import qualified Data.Typeable as Typeable import qualified Data.Word as Word import qualified GHC.Float as Float import qualified Numeric.Natural as Natural -import qualified Witch.Cast as Cast +import qualified Witch.From as From import qualified Witch.TryCast as TryCast import qualified Witch.TryCastException as TryCastException import qualified Witch.Utility as Utility @@ -37,24 +37,24 @@ import qualified Witch.Utility as Utility -- Int8 -- | Uses 'fromIntegral'. -instance Cast.Cast Int.Int8 Int.Int16 where - cast = fromIntegral +instance From.From Int.Int8 Int.Int16 where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Int.Int8 Int.Int32 where - cast = fromIntegral +instance From.From Int.Int8 Int.Int32 where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Int.Int8 Int.Int64 where - cast = fromIntegral +instance From.From Int.Int8 Int.Int64 where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Int.Int8 Int where - cast = fromIntegral +instance From.From Int.Int8 Int where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Int.Int8 Integer where - cast = fromIntegral +instance From.From Int.Int8 Integer where + from = fromIntegral -- | Uses 'Bits.toIntegralSized'. instance TryCast.TryCast Int.Int8 Word.Word8 where @@ -81,12 +81,12 @@ instance TryCast.TryCast Int.Int8 Natural.Natural where tryCast = Utility.eitherTryCast fromNonNegativeIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Int.Int8 Float where - cast = fromIntegral +instance From.From Int.Int8 Float where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Int.Int8 Double where - cast = fromIntegral +instance From.From Int.Int8 Double where + from = fromIntegral -- Int16 @@ -95,20 +95,20 @@ instance TryCast.TryCast Int.Int16 Int.Int8 where tryCast = Utility.maybeTryCast Bits.toIntegralSized -- | Uses 'fromIntegral'. -instance Cast.Cast Int.Int16 Int.Int32 where - cast = fromIntegral +instance From.From Int.Int16 Int.Int32 where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Int.Int16 Int.Int64 where - cast = fromIntegral +instance From.From Int.Int16 Int.Int64 where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Int.Int16 Int where - cast = fromIntegral +instance From.From Int.Int16 Int where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Int.Int16 Integer where - cast = fromIntegral +instance From.From Int.Int16 Integer where + from = fromIntegral -- | Uses 'Bits.toIntegralSized'. instance TryCast.TryCast Int.Int16 Word.Word8 where @@ -135,12 +135,12 @@ instance TryCast.TryCast Int.Int16 Natural.Natural where tryCast = Utility.eitherTryCast fromNonNegativeIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Int.Int16 Float where - cast = fromIntegral +instance From.From Int.Int16 Float where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Int.Int16 Double where - cast = fromIntegral +instance From.From Int.Int16 Double where + from = fromIntegral -- Int32 @@ -153,16 +153,16 @@ instance TryCast.TryCast Int.Int32 Int.Int16 where tryCast = Utility.maybeTryCast Bits.toIntegralSized -- | Uses 'fromIntegral'. -instance Cast.Cast Int.Int32 Int.Int64 where - cast = fromIntegral +instance From.From Int.Int32 Int.Int64 where + from = fromIntegral -- | Uses 'Bits.toIntegralSized'. instance TryCast.TryCast Int.Int32 Int where tryCast = Utility.maybeTryCast Bits.toIntegralSized -- | Uses 'fromIntegral'. -instance Cast.Cast Int.Int32 Integer where - cast = fromIntegral +instance From.From Int.Int32 Integer where + from = fromIntegral -- | Uses 'Bits.toIntegralSized'. instance TryCast.TryCast Int.Int32 Word.Word8 where @@ -198,8 +198,8 @@ instance TryCast.TryCast Int.Int32 Float where else Right $ fromIntegral s -- | Uses 'fromIntegral'. -instance Cast.Cast Int.Int32 Double where - cast = fromIntegral +instance From.From Int.Int32 Double where + from = fromIntegral -- Int64 @@ -220,8 +220,8 @@ instance TryCast.TryCast Int.Int64 Int where tryCast = Utility.maybeTryCast Bits.toIntegralSized -- | Uses 'fromIntegral'. -instance Cast.Cast Int.Int64 Integer where - cast = fromIntegral +instance From.From Int.Int64 Integer where + from = fromIntegral -- | Uses 'Bits.toIntegralSized'. instance TryCast.TryCast Int.Int64 Word.Word8 where @@ -280,12 +280,12 @@ instance TryCast.TryCast Int Int.Int32 where tryCast = Utility.maybeTryCast Bits.toIntegralSized -- | Uses 'fromIntegral'. -instance Cast.Cast Int Int.Int64 where - cast = fromIntegral +instance From.From Int Int.Int64 where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Int Integer where - cast = fromIntegral +instance From.From Int Integer where + from = fromIntegral -- | Uses 'Bits.toIntegralSized'. instance TryCast.TryCast Int Word.Word8 where @@ -404,56 +404,56 @@ instance TryCast.TryCast Integer Double where -- Word8 -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word8 Word.Word16 where - cast = fromIntegral +instance From.From Word.Word8 Word.Word16 where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word8 Word.Word32 where - cast = fromIntegral +instance From.From Word.Word8 Word.Word32 where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word8 Word.Word64 where - cast = fromIntegral +instance From.From Word.Word8 Word.Word64 where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word8 Word where - cast = fromIntegral +instance From.From Word.Word8 Word where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word8 Natural.Natural where - cast = fromIntegral +instance From.From Word.Word8 Natural.Natural where + from = fromIntegral -- | Uses 'Bits.toIntegralSized'. instance TryCast.TryCast Word.Word8 Int.Int8 where tryCast = Utility.maybeTryCast Bits.toIntegralSized -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word8 Int.Int16 where - cast = fromIntegral +instance From.From Word.Word8 Int.Int16 where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word8 Int.Int32 where - cast = fromIntegral +instance From.From Word.Word8 Int.Int32 where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word8 Int.Int64 where - cast = fromIntegral +instance From.From Word.Word8 Int.Int64 where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word8 Int where - cast = fromIntegral +instance From.From Word.Word8 Int where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word8 Integer where - cast = fromIntegral +instance From.From Word.Word8 Integer where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word8 Float where - cast = fromIntegral +instance From.From Word.Word8 Float where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word8 Double where - cast = fromIntegral +instance From.From Word.Word8 Double where + from = fromIntegral -- Word16 @@ -462,20 +462,20 @@ instance TryCast.TryCast Word.Word16 Word.Word8 where tryCast = Utility.maybeTryCast Bits.toIntegralSized -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word16 Word.Word32 where - cast = fromIntegral +instance From.From Word.Word16 Word.Word32 where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word16 Word.Word64 where - cast = fromIntegral +instance From.From Word.Word16 Word.Word64 where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word16 Word where - cast = fromIntegral +instance From.From Word.Word16 Word where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word16 Natural.Natural where - cast = fromIntegral +instance From.From Word.Word16 Natural.Natural where + from = fromIntegral -- | Uses 'Bits.toIntegralSized'. instance TryCast.TryCast Word.Word16 Int.Int8 where @@ -486,28 +486,28 @@ instance TryCast.TryCast Word.Word16 Int.Int16 where tryCast = Utility.maybeTryCast Bits.toIntegralSized -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word16 Int.Int32 where - cast = fromIntegral +instance From.From Word.Word16 Int.Int32 where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word16 Int.Int64 where - cast = fromIntegral +instance From.From Word.Word16 Int.Int64 where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word16 Int where - cast = fromIntegral +instance From.From Word.Word16 Int where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word16 Integer where - cast = fromIntegral +instance From.From Word.Word16 Integer where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word16 Float where - cast = fromIntegral +instance From.From Word.Word16 Float where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word16 Double where - cast = fromIntegral +instance From.From Word.Word16 Double where + from = fromIntegral -- Word32 @@ -520,16 +520,16 @@ instance TryCast.TryCast Word.Word32 Word.Word16 where tryCast = Utility.maybeTryCast Bits.toIntegralSized -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word32 Word.Word64 where - cast = fromIntegral +instance From.From Word.Word32 Word.Word64 where + from = fromIntegral -- | Uses 'Bits.toIntegralSized'. instance TryCast.TryCast Word.Word32 Word where tryCast = Utility.maybeTryCast Bits.toIntegralSized -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word32 Natural.Natural where - cast = fromIntegral +instance From.From Word.Word32 Natural.Natural where + from = fromIntegral -- | Uses 'Bits.toIntegralSized'. instance TryCast.TryCast Word.Word32 Int.Int8 where @@ -544,16 +544,16 @@ instance TryCast.TryCast Word.Word32 Int.Int32 where tryCast = Utility.maybeTryCast Bits.toIntegralSized -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word32 Int.Int64 where - cast = fromIntegral +instance From.From Word.Word32 Int.Int64 where + from = fromIntegral -- | Uses 'Bits.toIntegralSized'. instance TryCast.TryCast Word.Word32 Int where tryCast = Utility.maybeTryCast Bits.toIntegralSized -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word32 Integer where - cast = fromIntegral +instance From.From Word.Word32 Integer where + from = fromIntegral -- | Uses 'fromIntegral' when the input is less than or equal to 16,777,215. instance TryCast.TryCast Word.Word32 Float where @@ -561,8 +561,8 @@ instance TryCast.TryCast Word.Word32 Float where if s <= maxFloat then Right $ fromIntegral s else Left Exception.Overflow -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word32 Double where - cast = fromIntegral +instance From.From Word.Word32 Double where + from = fromIntegral -- Word64 @@ -583,8 +583,8 @@ instance TryCast.TryCast Word.Word64 Word where tryCast = Utility.maybeTryCast Bits.toIntegralSized -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word64 Natural.Natural where - cast = fromIntegral +instance From.From Word.Word64 Natural.Natural where + from = fromIntegral -- | Uses 'Bits.toIntegralSized'. instance TryCast.TryCast Word.Word64 Int.Int8 where @@ -607,8 +607,8 @@ instance TryCast.TryCast Word.Word64 Int where tryCast = Utility.maybeTryCast Bits.toIntegralSized -- | Uses 'fromIntegral'. -instance Cast.Cast Word.Word64 Integer where - cast = fromIntegral +instance From.From Word.Word64 Integer where + from = fromIntegral -- | Uses 'fromIntegral' when the input is less than or equal to 16,777,215. instance TryCast.TryCast Word.Word64 Float where @@ -637,12 +637,12 @@ instance TryCast.TryCast Word Word.Word32 where tryCast = Utility.maybeTryCast Bits.toIntegralSized -- | Uses 'fromIntegral'. -instance Cast.Cast Word Word.Word64 where - cast = fromIntegral +instance From.From Word Word.Word64 where + from = fromIntegral -- | Uses 'fromIntegral'. -instance Cast.Cast Word Natural.Natural where - cast = fromIntegral +instance From.From Word Natural.Natural where + from = fromIntegral -- | Uses 'Bits.toIntegralSized'. instance TryCast.TryCast Word Int.Int8 where @@ -665,8 +665,8 @@ instance TryCast.TryCast Word Int where tryCast = Utility.maybeTryCast Bits.toIntegralSized -- | Uses 'fromIntegral'. -instance Cast.Cast Word Integer where - cast = fromIntegral +instance From.From Word Integer where + from = fromIntegral -- | Uses 'fromIntegral' when the input is less than or equal to 16,777,215. instance TryCast.TryCast Word Float where @@ -724,8 +724,8 @@ instance TryCast.TryCast Natural.Natural Int where tryCast = Utility.maybeTryCast Bits.toIntegralSized -- | Uses 'fromIntegral'. -instance Cast.Cast Natural.Natural Integer where - cast = fromIntegral +instance From.From Natural.Natural Integer where + from = fromIntegral -- | Uses 'fromIntegral' when the input is less than or equal to 16,777,215. instance TryCast.TryCast Natural.Natural Float where @@ -804,8 +804,8 @@ instance TryCast.TryCast Float Rational where else Right $ toRational s -- | Uses 'Float.float2Double'. -instance Cast.Cast Float Double where - cast = Float.float2Double +instance From.From Float Double where + from = Float.float2Double -- Double @@ -872,14 +872,14 @@ instance TryCast.TryCast Double Rational where else Right $ toRational s -- | Uses 'Float.double2Float'. This necessarily loses some precision. -instance Cast.Cast Double Float where - cast = Float.double2Float +instance From.From Double Float where + from = Float.double2Float -- Ratio -- | Uses '(Ratio.%)' with a denominator of 1. -instance Integral a => Cast.Cast a (Ratio.Ratio a) where - cast = (Ratio.% 1) +instance Integral a => From.From a (Ratio.Ratio a) where + from = (Ratio.% 1) -- | Uses 'Ratio.numerator' when the denominator is 1. instance (Eq a, Num a) => TryCast.TryCast (Ratio.Ratio a) a where @@ -888,30 +888,30 @@ instance (Eq a, Num a) => TryCast.TryCast (Ratio.Ratio a) a where else Left Exception.LossOfPrecision -- | Uses 'fromRational'. This necessarily loses some precision. -instance Cast.Cast Rational Float where - cast = fromRational +instance From.From Rational Float where + from = fromRational -- | Uses 'fromRational'. This necessarily loses some precision. -instance Cast.Cast Rational Double where - cast = fromRational +instance From.From Rational Double where + from = fromRational -- Fixed --- | Uses 'Fixed.MkFixed'. This means @cast 2 :: Centi@ is @0.02@ rather than +-- | Uses 'Fixed.MkFixed'. This means @from 2 :: Centi@ is @0.02@ rather than -- @2.00@. -instance Cast.Cast Integer (Fixed.Fixed a) where - cast = Fixed.MkFixed +instance From.From Integer (Fixed.Fixed a) where + from = Fixed.MkFixed --- | Uses 'Fixed.MkFixed'. This means @cast (3.00 :: Centi)@ is @300@ rather +-- | Uses 'Fixed.MkFixed'. This means @from (3.00 :: Centi)@ is @300@ rather -- than @3@. -instance Cast.Cast (Fixed.Fixed a) Integer where - cast (Fixed.MkFixed t) = t +instance From.From (Fixed.Fixed a) Integer where + from (Fixed.MkFixed t) = t -- Complex -- | Uses '(Complex.:+)' with an imaginary part of 0. -instance Num a => Cast.Cast a (Complex.Complex a) where - cast = (Complex.:+ 0) +instance Num a => From.From a (Complex.Complex a) where + from = (Complex.:+ 0) -- | Uses 'Complex.realPart' when the imaginary part is 0. instance (Eq a, Num a) => TryCast.TryCast (Complex.Complex a) a where @@ -926,78 +926,78 @@ instance TryCast.TryCast [a] (NonEmpty.NonEmpty a) where tryCast = Utility.maybeTryCast NonEmpty.nonEmpty -- | Uses 'NonEmpty.toList'. -instance Cast.Cast (NonEmpty.NonEmpty a) [a] where - cast = NonEmpty.toList +instance From.From (NonEmpty.NonEmpty a) [a] where + from = NonEmpty.toList -- Set -- | Uses 'Set.fromList'. -instance Ord a => Cast.Cast [a] (Set.Set a) where - cast = Set.fromList +instance Ord a => From.From [a] (Set.Set a) where + from = Set.fromList -- | Uses 'Set.toAscList'. -instance Cast.Cast (Set.Set a) [a] where - cast = Set.toAscList +instance From.From (Set.Set a) [a] where + from = Set.toAscList -- IntSet -- | Uses 'IntSet.fromList'. -instance Cast.Cast [Int] IntSet.IntSet where - cast = IntSet.fromList +instance From.From [Int] IntSet.IntSet where + from = IntSet.fromList -- | Uses 'IntSet.toAscList'. -instance Cast.Cast IntSet.IntSet [Int] where - cast = IntSet.toAscList +instance From.From IntSet.IntSet [Int] where + from = IntSet.toAscList -- Map -- | Uses 'Map.fromList'. If there are duplicate keys, later values will -- overwrite earlier ones. -instance Ord k => Cast.Cast [(k, v)] (Map.Map k v) where - cast = Map.fromList +instance Ord k => From.From [(k, v)] (Map.Map k v) where + from = Map.fromList -- | Uses 'Map.toAscList'. -instance Cast.Cast (Map.Map k v) [(k, v)] where - cast = Map.toAscList +instance From.From (Map.Map k v) [(k, v)] where + from = Map.toAscList -- IntMap -- | Uses 'IntMap.fromList'. If there are duplicate keys, later values will -- overwrite earlier ones. -instance Cast.Cast [(Int, v)] (IntMap.IntMap v) where - cast = IntMap.fromList +instance From.From [(Int, v)] (IntMap.IntMap v) where + from = IntMap.fromList -- | Uses 'IntMap.toAscList'. -instance Cast.Cast (IntMap.IntMap v) [(Int, v)] where - cast = IntMap.toAscList +instance From.From (IntMap.IntMap v) [(Int, v)] where + from = IntMap.toAscList -- Seq -- | Uses 'Seq.fromList'. -instance Cast.Cast [a] (Seq.Seq a) where - cast = Seq.fromList +instance From.From [a] (Seq.Seq a) where + from = Seq.fromList -- | Uses 'Foldable.toList'. -instance Cast.Cast (Seq.Seq a) [a] where - cast = Foldable.toList +instance From.From (Seq.Seq a) [a] where + from = Foldable.toList -- ByteString -- | Uses 'ByteString.pack'. -instance Cast.Cast [Word.Word8] ByteString.ByteString where - cast = ByteString.pack +instance From.From [Word.Word8] ByteString.ByteString where + from = ByteString.pack -- | Uses 'ByteString.unpack'. -instance Cast.Cast ByteString.ByteString [Word.Word8] where - cast = ByteString.unpack +instance From.From ByteString.ByteString [Word.Word8] where + from = ByteString.unpack -- | Uses 'LazyByteString.fromStrict'. -instance Cast.Cast ByteString.ByteString LazyByteString.ByteString where - cast = LazyByteString.fromStrict +instance From.From ByteString.ByteString LazyByteString.ByteString where + from = LazyByteString.fromStrict -- | Uses 'ShortByteString.toShort'. -instance Cast.Cast ByteString.ByteString ShortByteString.ShortByteString where - cast = ShortByteString.toShort +instance From.From ByteString.ByteString ShortByteString.ShortByteString where + from = ShortByteString.toShort -- | Uses 'Text.decodeUtf8''. instance TryCast.TryCast ByteString.ByteString Text.Text where @@ -1006,16 +1006,16 @@ instance TryCast.TryCast ByteString.ByteString Text.Text where -- LazyByteString -- | Uses 'LazyByteString.pack'. -instance Cast.Cast [Word.Word8] LazyByteString.ByteString where - cast = LazyByteString.pack +instance From.From [Word.Word8] LazyByteString.ByteString where + from = LazyByteString.pack -- | Uses 'LazyByteString.unpack'. -instance Cast.Cast LazyByteString.ByteString [Word.Word8] where - cast = LazyByteString.unpack +instance From.From LazyByteString.ByteString [Word.Word8] where + from = LazyByteString.unpack -- | Uses 'LazyByteString.toStrict'. -instance Cast.Cast LazyByteString.ByteString ByteString.ByteString where - cast = LazyByteString.toStrict +instance From.From LazyByteString.ByteString ByteString.ByteString where + from = LazyByteString.toStrict -- | Uses 'LazyText.decodeUtf8''. instance TryCast.TryCast LazyByteString.ByteString LazyText.Text where @@ -1024,59 +1024,59 @@ instance TryCast.TryCast LazyByteString.ByteString LazyText.Text where -- ShortByteString -- | Uses 'ShortByteString.pack'. -instance Cast.Cast [Word.Word8] ShortByteString.ShortByteString where - cast = ShortByteString.pack +instance From.From [Word.Word8] ShortByteString.ShortByteString where + from = ShortByteString.pack -- | Uses 'ShortByteString.unpack'. -instance Cast.Cast ShortByteString.ShortByteString [Word.Word8] where - cast = ShortByteString.unpack +instance From.From ShortByteString.ShortByteString [Word.Word8] where + from = ShortByteString.unpack -- | Uses 'ShortByteString.fromShort'. -instance Cast.Cast ShortByteString.ShortByteString ByteString.ByteString where - cast = ShortByteString.fromShort +instance From.From ShortByteString.ShortByteString ByteString.ByteString where + from = ShortByteString.fromShort -- Text -- | Uses 'Text.pack'. Some 'Char' values cannot be represented in 'Text.Text' -- and will be replaced with @'\\xFFFD'@. -instance Cast.Cast String Text.Text where - cast = Text.pack +instance From.From String Text.Text where + from = Text.pack -- | Uses 'Text.unpack'. -instance Cast.Cast Text.Text String where - cast = Text.unpack +instance From.From Text.Text String where + from = Text.unpack -- | Uses 'LazyText.fromStrict'. -instance Cast.Cast Text.Text LazyText.Text where - cast = LazyText.fromStrict +instance From.From Text.Text LazyText.Text where + from = LazyText.fromStrict -- | Uses 'Text.encodeUtf8'. -instance Cast.Cast Text.Text ByteString.ByteString where - cast = Text.encodeUtf8 +instance From.From Text.Text ByteString.ByteString where + from = Text.encodeUtf8 -- LazyText -- | Uses 'LazyText.pack'. Some 'Char' values cannot be represented in -- 'LazyText.Text' and will be replaced with @'\\xFFFD'@. -instance Cast.Cast String LazyText.Text where - cast = LazyText.pack +instance From.From String LazyText.Text where + from = LazyText.pack -- | Uses 'LazyText.unpack'. -instance Cast.Cast LazyText.Text String where - cast = LazyText.unpack +instance From.From LazyText.Text String where + from = LazyText.unpack -- | Uses 'LazyText.toStrict'. -instance Cast.Cast LazyText.Text Text.Text where - cast = LazyText.toStrict +instance From.From LazyText.Text Text.Text where + from = LazyText.toStrict -- | Uses 'LazyText.encodeUtf8'. -instance Cast.Cast LazyText.Text LazyByteString.ByteString where - cast = LazyText.encodeUtf8 +instance From.From LazyText.Text LazyByteString.ByteString where + from = LazyText.encodeUtf8 -- TryCastException -- | Uses @coerce@. -instance Cast.Cast +instance From.From (TryCastException.TryCastException s u) (TryCastException.TryCastException s t) @@ -1085,24 +1085,24 @@ instance ( Show s , Typeable.Typeable s , Typeable.Typeable t - ) => Cast.Cast (TryCastException.TryCastException s t) String where - cast = show + ) => From.From (TryCastException.TryCastException s t) String where + from = show -- | Converts via 'String'. instance ( Show s , Typeable.Typeable s , Typeable.Typeable t - ) => Cast.Cast (TryCastException.TryCastException s t) Text.Text where - cast = Utility.via @String + ) => From.From (TryCastException.TryCastException s t) Text.Text where + from = Utility.via @String -- | Converts via 'String'. instance ( Show s , Typeable.Typeable s , Typeable.Typeable t - ) => Cast.Cast (TryCastException.TryCastException s t) LazyText.Text where - cast = Utility.via @String + ) => From.From (TryCastException.TryCastException s t) LazyText.Text where + from = Utility.via @String fromNonNegativeIntegral :: (Integral s, Num t) => s -> Either Exception.ArithException t diff --git a/src/lib/Witch/TryCast.hs b/src/lib/Witch/TryCast.hs index f6abc44..86236f6 100644 --- a/src/lib/Witch/TryCast.hs +++ b/src/lib/Witch/TryCast.hs @@ -10,7 +10,7 @@ import qualified Witch.TryCastException as TryCastException -- type @target@, but that conversion may fail at runtime. -- -- This type class is for conversions that can fail. If your conversion cannot --- fail, consider implementing @Cast@ instead. +-- fail, consider implementing @From@ instead. class TryCast source target where -- | This method implements the conversion of a value between types. At call -- sites you will usually want to use @tryFrom@ or @tryInto@ instead of this diff --git a/src/lib/Witch/Utility.hs b/src/lib/Witch/Utility.hs index baff218..ea09f5c 100644 --- a/src/lib/Witch/Utility.hs +++ b/src/lib/Witch/Utility.hs @@ -6,7 +6,7 @@ module Witch.Utility where import qualified Control.Exception as Exception import qualified Data.Typeable as Typeable import qualified GHC.Stack as Stack -import qualified Witch.Cast as Cast +import qualified Witch.From as From import qualified Witch.TryCast as TryCast import qualified Witch.TryCastException as TryCastException @@ -22,35 +22,20 @@ import qualified Witch.TryCastException as TryCastException as :: forall source . source -> source as = id --- | This is the same as 'Cast.cast' except that it requires a type --- application for the @source@ type. --- --- > -- Avoid this: --- > cast (x :: s) --- > --- > -- Prefer this: --- > from @s x -from - :: forall source target - . Cast.Cast source target - => source - -> target -from = Cast.cast - --- | This is the same as 'Cast.cast' except that it requires a type +-- | This is the same as 'From.from' except that it requires a type -- application for the @target@ type. -- -- > -- Avoid this: --- > cast x :: t +-- > from x :: t -- > -- > -- Prefer this: -- > into @t x into :: forall target source - . Cast.Cast source target + . From.From source target => source -> target -into = Cast.cast +into = From.from -- | This function converts from some @source@ type into some @target@ type, -- applies the given function, then converts back into the @source@ type. This @@ -64,17 +49,17 @@ into = Cast.cast -- > over @t f over :: forall target source - . ( Cast.Cast source target - , Cast.Cast target source + . ( From.From source target + , From.From target source ) => (target -> target) -> source -> source -over f = Cast.cast . f . Cast.cast +over f = From.from . f . From.from -- | This function first converts from some @source@ type into some @through@ -- type, and then converts that into some @target@ type. Usually this is used --- when writing 'Cast.Cast' instances. Sometimes this can be used to work +-- when writing 'From.From' instances. Sometimes this can be used to work -- around the lack of an instance that should probably exist. -- -- > -- Avoid this: @@ -84,12 +69,12 @@ over f = Cast.cast . f . Cast.cast -- > via @u via :: forall through source target - . ( Cast.Cast source through - , Cast.Cast through target + . ( From.From source through + , From.From through target ) => source -> target -via = Cast.cast . (\x -> x :: through) . Cast.cast +via = From.from . (\x -> x :: through) . From.from -- | This is the same as 'TryCast.tryCast' except that it requires a type -- application for the @source@ type. @@ -191,7 +176,7 @@ eitherTryCast f s = case f s of -- impure exception if the conversion fails. -- -- > -- Avoid this: --- > either throw id . cast +-- > either throw id . from -- > -- > -- Prefer this: -- > unsafeCast diff --git a/src/test/Main.hs b/src/test/Main.hs index 0e4c2bf..3866223 100644 --- a/src/test/Main.hs +++ b/src/test/Main.hs @@ -27,10 +27,10 @@ import qualified Witch main :: IO () main = Hspec.hspec . Hspec.describe "Witch" $ do - Hspec.describe "Cast" $ do + Hspec.describe "From" $ do - Hspec.describe "cast" $ do - test $ Witch.cast (1 :: Int.Int8) `Hspec.shouldBe` (1 :: Int.Int16) + Hspec.describe "from" $ do + test $ Witch.from (1 :: Int.Int8) `Hspec.shouldBe` (1 :: Int.Int16) Hspec.describe "TryCast" $ do @@ -87,32 +87,32 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do -- Int8 - Hspec.describe "Cast Int8 Int16" $ do - let f = Witch.cast @Int.Int8 @Int.Int16 + Hspec.describe "From Int8 Int16" $ do + let f = Witch.from @Int.Int8 @Int.Int16 test $ f 0 `Hspec.shouldBe` 0 test $ f 127 `Hspec.shouldBe` 127 test $ f (-128) `Hspec.shouldBe` (-128) - Hspec.describe "Cast Int8 Int32" $ do - let f = Witch.cast @Int.Int8 @Int.Int32 + Hspec.describe "From Int8 Int32" $ do + let f = Witch.from @Int.Int8 @Int.Int32 test $ f 0 `Hspec.shouldBe` 0 test $ f 127 `Hspec.shouldBe` 127 test $ f (-128) `Hspec.shouldBe` (-128) - Hspec.describe "Cast Int8 Int64" $ do - let f = Witch.cast @Int.Int8 @Int.Int64 + Hspec.describe "From Int8 Int64" $ do + let f = Witch.from @Int.Int8 @Int.Int64 test $ f 0 `Hspec.shouldBe` 0 test $ f 127 `Hspec.shouldBe` 127 test $ f (-128) `Hspec.shouldBe` (-128) - Hspec.describe "Cast Int8 Int" $ do - let f = Witch.cast @Int.Int8 @Int + Hspec.describe "From Int8 Int" $ do + let f = Witch.from @Int.Int8 @Int test $ f 0 `Hspec.shouldBe` 0 test $ f 127 `Hspec.shouldBe` 127 test $ f (-128) `Hspec.shouldBe` (-128) - Hspec.describe "Cast Int8 Integer" $ do - let f = Witch.cast @Int.Int8 @Integer + Hspec.describe "From Int8 Integer" $ do + let f = Witch.from @Int.Int8 @Integer test $ f 0 `Hspec.shouldBe` 0 test $ f 127 `Hspec.shouldBe` 127 test $ f (-128) `Hspec.shouldBe` (-128) @@ -153,14 +153,14 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f 127 `Hspec.shouldBe` Just 127 test $ f (-1) `Hspec.shouldBe` Nothing - Hspec.describe "Cast Int8 Float" $ do - let f = Witch.cast @Int.Int8 @Float + Hspec.describe "From Int8 Float" $ do + let f = Witch.from @Int.Int8 @Float test $ f 0 `Hspec.shouldBe` 0 test $ f 127 `Hspec.shouldBe` 127 test $ f (-128) `Hspec.shouldBe` (-128) - Hspec.describe "Cast Int8 Double" $ do - let f = Witch.cast @Int.Int8 @Double + Hspec.describe "From Int8 Double" $ do + let f = Witch.from @Int.Int8 @Double test $ f 0 `Hspec.shouldBe` 0 test $ f 127 `Hspec.shouldBe` 127 test $ f (-128) `Hspec.shouldBe` (-128) @@ -175,26 +175,26 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f (-128) `Hspec.shouldBe` Just (-128) test $ f (-129) `Hspec.shouldBe` Nothing - Hspec.describe "Cast Int16 Int32" $ do - let f = Witch.cast @Int.Int16 @Int.Int32 + Hspec.describe "From Int16 Int32" $ do + let f = Witch.from @Int.Int16 @Int.Int32 test $ f 0 `Hspec.shouldBe` 0 test $ f 32767 `Hspec.shouldBe` 32767 test $ f (-32768) `Hspec.shouldBe` (-32768) - Hspec.describe "Cast Int16 Int64" $ do - let f = Witch.cast @Int.Int16 @Int.Int64 + Hspec.describe "From Int16 Int64" $ do + let f = Witch.from @Int.Int16 @Int.Int64 test $ f 0 `Hspec.shouldBe` 0 test $ f 32767 `Hspec.shouldBe` 32767 test $ f (-32768) `Hspec.shouldBe` (-32768) - Hspec.describe "Cast Int16 Int" $ do - let f = Witch.cast @Int.Int16 @Int + Hspec.describe "From Int16 Int" $ do + let f = Witch.from @Int.Int16 @Int test $ f 0 `Hspec.shouldBe` 0 test $ f 32767 `Hspec.shouldBe` 32767 test $ f (-32768) `Hspec.shouldBe` (-32768) - Hspec.describe "Cast Int16 Integer" $ do - let f = Witch.cast @Int.Int16 @Integer + Hspec.describe "From Int16 Integer" $ do + let f = Witch.from @Int.Int16 @Integer test $ f 0 `Hspec.shouldBe` 0 test $ f 32767 `Hspec.shouldBe` 32767 test $ f (-32768) `Hspec.shouldBe` (-32768) @@ -236,14 +236,14 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f 32767 `Hspec.shouldBe` Just 32767 test $ f (-1) `Hspec.shouldBe` Nothing - Hspec.describe "Cast Int16 Float" $ do - let f = Witch.cast @Int.Int16 @Float + Hspec.describe "From Int16 Float" $ do + let f = Witch.from @Int.Int16 @Float test $ f 0 `Hspec.shouldBe` 0 test $ f 32767 `Hspec.shouldBe` 32767 test $ f (-32768) `Hspec.shouldBe` (-32768) - Hspec.describe "Cast Int16 Double" $ do - let f = Witch.cast @Int.Int16 @Double + Hspec.describe "From Int16 Double" $ do + let f = Witch.from @Int.Int16 @Double test $ f 0 `Hspec.shouldBe` 0 test $ f 32767 `Hspec.shouldBe` 32767 test $ f (-32768) `Hspec.shouldBe` (-32768) @@ -266,8 +266,8 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f (-32768) `Hspec.shouldBe` Just (-32768) test $ f (-32769) `Hspec.shouldBe` Nothing - Hspec.describe "Cast Int32 Int64" $ do - let f = Witch.cast @Int.Int32 @Int.Int64 + Hspec.describe "From Int32 Int64" $ do + let f = Witch.from @Int.Int32 @Int.Int64 test $ f 0 `Hspec.shouldBe` 0 test $ f 2147483647 `Hspec.shouldBe` 2147483647 test $ f (-2147483648) `Hspec.shouldBe` (-2147483648) @@ -279,8 +279,8 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f 2147483647 `Hspec.shouldBe` Just 2147483647 test $ f (-2147483648) `Hspec.shouldBe` Just (-2147483648) - Hspec.describe "Cast Int32 Integer" $ do - let f = Witch.cast @Int.Int32 @Integer + Hspec.describe "From Int32 Integer" $ do + let f = Witch.from @Int.Int32 @Integer test $ f 0 `Hspec.shouldBe` 0 test $ f 2147483647 `Hspec.shouldBe` 2147483647 test $ f (-2147483648) `Hspec.shouldBe` (-2147483648) @@ -332,8 +332,8 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f (-16777215) `Hspec.shouldBe` Just (-16777215) test $ f (-16777216) `Hspec.shouldBe` Nothing - Hspec.describe "Cast Int32 Double" $ do - let f = Witch.cast @Int.Int32 @Double + Hspec.describe "From Int32 Double" $ do + let f = Witch.from @Int.Int32 @Double test $ f 0 `Hspec.shouldBe` 0 test $ f 2147483647 `Hspec.shouldBe` 2147483647 test $ f (-2147483648) `Hspec.shouldBe` (-2147483648) @@ -371,8 +371,8 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f 9223372036854775807 `Hspec.shouldBe` Just 9223372036854775807 test $ f (-9223372036854775808) `Hspec.shouldBe` Just (-9223372036854775808) - Hspec.describe "Cast Int64 Integer" $ do - let f = Witch.cast @Int.Int64 @Integer + Hspec.describe "From Int64 Integer" $ do + let f = Witch.from @Int.Int64 @Integer test $ f 0 `Hspec.shouldBe` 0 test $ f 9223372036854775807 `Hspec.shouldBe` 9223372036854775807 test $ f (-9223372036854775808) `Hspec.shouldBe` (-9223372036854775808) @@ -459,14 +459,14 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f (-2147483648) `Hspec.shouldBe` Just (-2147483648) test $ f (-2147483649) `Hspec.shouldBe` Nothing - Hspec.describe "Cast Int Int64" $ do - let f = Witch.cast @Int @Int.Int64 + Hspec.describe "From Int Int64" $ do + let f = Witch.from @Int @Int.Int64 test $ f 0 `Hspec.shouldBe` 0 test $ f maxBound `Hspec.shouldBe` fromIntegral (maxBound :: Int) test $ f minBound `Hspec.shouldBe` fromIntegral (minBound :: Int) - Hspec.describe "Cast Int Integer" $ do - let f = Witch.cast @Int @Integer + Hspec.describe "From Int Integer" $ do + let f = Witch.from @Int @Integer test $ f 0 `Hspec.shouldBe` 0 test $ f maxBound `Hspec.shouldBe` fromIntegral (maxBound :: Int) test $ f minBound `Hspec.shouldBe` fromIntegral (minBound :: Int) @@ -629,28 +629,28 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do -- Word8 - Hspec.describe "Cast Word8 Word16" $ do - let f = Witch.cast @Word.Word8 @Word.Word16 + Hspec.describe "From Word8 Word16" $ do + let f = Witch.from @Word.Word8 @Word.Word16 test $ f 0 `Hspec.shouldBe` 0 test $ f 255 `Hspec.shouldBe` 255 - Hspec.describe "Cast Word8 Word32" $ do - let f = Witch.cast @Word.Word8 @Word.Word32 + Hspec.describe "From Word8 Word32" $ do + let f = Witch.from @Word.Word8 @Word.Word32 test $ f 0 `Hspec.shouldBe` 0 test $ f 255 `Hspec.shouldBe` 255 - Hspec.describe "Cast Word8 Word64" $ do - let f = Witch.cast @Word.Word8 @Word.Word64 + Hspec.describe "From Word8 Word64" $ do + let f = Witch.from @Word.Word8 @Word.Word64 test $ f 0 `Hspec.shouldBe` 0 test $ f 255 `Hspec.shouldBe` 255 - Hspec.describe "Cast Word8 Word" $ do - let f = Witch.cast @Word.Word8 @Word + Hspec.describe "From Word8 Word" $ do + let f = Witch.from @Word.Word8 @Word test $ f 0 `Hspec.shouldBe` 0 test $ f 255 `Hspec.shouldBe` 255 - Hspec.describe "Cast Word8 Natural" $ do - let f = Witch.cast @Word.Word8 @Natural.Natural + Hspec.describe "From Word8 Natural" $ do + let f = Witch.from @Word.Word8 @Natural.Natural test $ f 0 `Hspec.shouldBe` 0 test $ f 255 `Hspec.shouldBe` 255 @@ -660,38 +660,38 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f 127 `Hspec.shouldBe` Just 127 test $ f 128 `Hspec.shouldBe` Nothing - Hspec.describe "Cast Word8 Int16" $ do - let f = Witch.cast @Word.Word8 @Int.Int16 + Hspec.describe "From Word8 Int16" $ do + let f = Witch.from @Word.Word8 @Int.Int16 test $ f 0 `Hspec.shouldBe` 0 test $ f 255 `Hspec.shouldBe` 255 - Hspec.describe "Cast Word8 Int32" $ do - let f = Witch.cast @Word.Word8 @Int.Int32 + Hspec.describe "From Word8 Int32" $ do + let f = Witch.from @Word.Word8 @Int.Int32 test $ f 0 `Hspec.shouldBe` 0 test $ f 255 `Hspec.shouldBe` 255 - Hspec.describe "Cast Word8 Int64" $ do - let f = Witch.cast @Word.Word8 @Int.Int64 + Hspec.describe "From Word8 Int64" $ do + let f = Witch.from @Word.Word8 @Int.Int64 test $ f 0 `Hspec.shouldBe` 0 test $ f 255 `Hspec.shouldBe` 255 - Hspec.describe "Cast Word8 Int" $ do - let f = Witch.cast @Word.Word8 @Int + Hspec.describe "From Word8 Int" $ do + let f = Witch.from @Word.Word8 @Int test $ f 0 `Hspec.shouldBe` 0 test $ f 255 `Hspec.shouldBe` 255 - Hspec.describe "Cast Word8 Integer" $ do - let f = Witch.cast @Word.Word8 @Integer + Hspec.describe "From Word8 Integer" $ do + let f = Witch.from @Word.Word8 @Integer test $ f 0 `Hspec.shouldBe` 0 test $ f 255 `Hspec.shouldBe` 255 - Hspec.describe "Cast Word8 Float" $ do - let f = Witch.cast @Word.Word8 @Float + Hspec.describe "From Word8 Float" $ do + let f = Witch.from @Word.Word8 @Float test $ f 0 `Hspec.shouldBe` 0 test $ f 255 `Hspec.shouldBe` 255 - Hspec.describe "Cast Word8 Double" $ do - let f = Witch.cast @Word.Word8 @Double + Hspec.describe "From Word8 Double" $ do + let f = Witch.from @Word.Word8 @Double test $ f 0 `Hspec.shouldBe` 0 test $ f 255 `Hspec.shouldBe` 255 @@ -703,23 +703,23 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f 255 `Hspec.shouldBe` Just 255 test $ f 256 `Hspec.shouldBe` Nothing - Hspec.describe "Cast Word16 Word32" $ do - let f = Witch.cast @Word.Word16 @Word.Word32 + Hspec.describe "From Word16 Word32" $ do + let f = Witch.from @Word.Word16 @Word.Word32 test $ f 0 `Hspec.shouldBe` 0 test $ f 65535 `Hspec.shouldBe` 65535 - Hspec.describe "Cast Word16 Word64" $ do - let f = Witch.cast @Word.Word16 @Word.Word64 + Hspec.describe "From Word16 Word64" $ do + let f = Witch.from @Word.Word16 @Word.Word64 test $ f 0 `Hspec.shouldBe` 0 test $ f 65535 `Hspec.shouldBe` 65535 - Hspec.describe "Cast Word16 Word" $ do - let f = Witch.cast @Word.Word16 @Word + Hspec.describe "From Word16 Word" $ do + let f = Witch.from @Word.Word16 @Word test $ f 0 `Hspec.shouldBe` 0 test $ f 65535 `Hspec.shouldBe` 65535 - Hspec.describe "Cast Word16 Natural" $ do - let f = Witch.cast @Word.Word16 @Natural.Natural + Hspec.describe "From Word16 Natural" $ do + let f = Witch.from @Word.Word16 @Natural.Natural test $ f 0 `Hspec.shouldBe` 0 test $ f 65535 `Hspec.shouldBe` 65535 @@ -735,33 +735,33 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f 32767 `Hspec.shouldBe` Just 32767 test $ f 32768 `Hspec.shouldBe` Nothing - Hspec.describe "Cast Word16 Int32" $ do - let f = Witch.cast @Word.Word16 @Int.Int32 + Hspec.describe "From Word16 Int32" $ do + let f = Witch.from @Word.Word16 @Int.Int32 test $ f 0 `Hspec.shouldBe` 0 test $ f 65535 `Hspec.shouldBe` 65535 - Hspec.describe "Cast Word16 Int64" $ do - let f = Witch.cast @Word.Word16 @Int.Int64 + Hspec.describe "From Word16 Int64" $ do + let f = Witch.from @Word.Word16 @Int.Int64 test $ f 0 `Hspec.shouldBe` 0 test $ f 65535 `Hspec.shouldBe` 65535 - Hspec.describe "Cast Word16 Int" $ do - let f = Witch.cast @Word.Word16 @Int + Hspec.describe "From Word16 Int" $ do + let f = Witch.from @Word.Word16 @Int test $ f 0 `Hspec.shouldBe` 0 test $ f 65535 `Hspec.shouldBe` 65535 - Hspec.describe "Cast Word16 Integer" $ do - let f = Witch.cast @Word.Word16 @Integer + Hspec.describe "From Word16 Integer" $ do + let f = Witch.from @Word.Word16 @Integer test $ f 0 `Hspec.shouldBe` 0 test $ f 65535 `Hspec.shouldBe` 65535 - Hspec.describe "Cast Word16 Float" $ do - let f = Witch.cast @Word.Word16 @Float + Hspec.describe "From Word16 Float" $ do + let f = Witch.from @Word.Word16 @Float test $ f 0 `Hspec.shouldBe` 0 test $ f 65535 `Hspec.shouldBe` 65535 - Hspec.describe "Cast Word16 Double" $ do - let f = Witch.cast @Word.Word16 @Double + Hspec.describe "From Word16 Double" $ do + let f = Witch.from @Word.Word16 @Double test $ f 0 `Hspec.shouldBe` 0 test $ f 65535 `Hspec.shouldBe` 65535 @@ -779,8 +779,8 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f 65535 `Hspec.shouldBe` Just 65535 test $ f 65536 `Hspec.shouldBe` Nothing - Hspec.describe "Cast Word32 Word64" $ do - let f = Witch.cast @Word.Word32 @Word.Word64 + Hspec.describe "From Word32 Word64" $ do + let f = Witch.from @Word.Word32 @Word.Word64 test $ f 0 `Hspec.shouldBe` 0 test $ f 4294967295 `Hspec.shouldBe` 4294967295 @@ -790,8 +790,8 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f 0 `Hspec.shouldBe` Just 0 test $ f 4294967295 `Hspec.shouldBe` Just 4294967295 - Hspec.describe "Cast Word32 Natural" $ do - let f = Witch.cast @Word.Word32 @Natural.Natural + Hspec.describe "From Word32 Natural" $ do + let f = Witch.from @Word.Word32 @Natural.Natural test $ f 0 `Hspec.shouldBe` 0 test $ f 4294967295 `Hspec.shouldBe` 4294967295 @@ -813,8 +813,8 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f 2147483647 `Hspec.shouldBe` Just 2147483647 test $ f 2147483648 `Hspec.shouldBe` Nothing - Hspec.describe "Cast Word32 Int64" $ do - let f = Witch.cast @Word.Word32 @Int.Int64 + Hspec.describe "From Word32 Int64" $ do + let f = Witch.from @Word.Word32 @Int.Int64 test $ f 0 `Hspec.shouldBe` 0 test $ f 4294967295 `Hspec.shouldBe` 4294967295 @@ -824,8 +824,8 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f 0 `Hspec.shouldBe` Just 0 test $ f 4294967295 `Hspec.shouldBe` Just 4294967295 - Hspec.describe "Cast Word32 Integer" $ do - let f = Witch.cast @Word.Word32 @Integer + Hspec.describe "From Word32 Integer" $ do + let f = Witch.from @Word.Word32 @Integer test $ f 0 `Hspec.shouldBe` 0 test $ f 4294967295 `Hspec.shouldBe` 4294967295 @@ -835,8 +835,8 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f 16777215 `Hspec.shouldBe` Just 16777215 test $ f 16777216 `Hspec.shouldBe` Nothing - Hspec.describe "Cast Word32 Double" $ do - let f = Witch.cast @Word.Word32 @Double + Hspec.describe "From Word32 Double" $ do + let f = Witch.from @Word.Word32 @Double test $ f 0 `Hspec.shouldBe` 0 test $ f 4294967295 `Hspec.shouldBe` 4294967295 @@ -866,8 +866,8 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f 0 `Hspec.shouldBe` Just 0 test $ f 18446744073709551615 `Hspec.shouldBe` Just 18446744073709551615 - Hspec.describe "Cast Word64 Natural" $ do - let f = Witch.cast @Word.Word64 @Natural.Natural + Hspec.describe "From Word64 Natural" $ do + let f = Witch.from @Word.Word64 @Natural.Natural test $ f 0 `Hspec.shouldBe` 0 test $ f 18446744073709551615 `Hspec.shouldBe` 18446744073709551615 @@ -901,8 +901,8 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ let x = maxBound :: Int in hush (Witch.tryCast @Word.Word64 @Int (fromIntegral x)) `Hspec.shouldBe` Just x test $ let x = fromIntegral (maxBound :: Int) + 1 :: Word.Word64 in hush (Witch.tryCast @Word.Word64 @Int x) `Hspec.shouldBe` Nothing - Hspec.describe "Cast Word64 Integer" $ do - let f = Witch.cast @Word.Word64 @Integer + Hspec.describe "From Word64 Integer" $ do + let f = Witch.from @Word.Word64 @Integer test $ f 0 `Hspec.shouldBe` 0 test $ f 18446744073709551615 `Hspec.shouldBe` 18446744073709551615 @@ -939,13 +939,13 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f 4294967295 `Hspec.shouldBe` Just 4294967295 test $ f 4294967296 `Hspec.shouldBe` Nothing - Hspec.describe "Cast Word Word64" $ do - let f = Witch.cast @Word @Word.Word64 + Hspec.describe "From Word Word64" $ do + let f = Witch.from @Word @Word.Word64 test $ f 0 `Hspec.shouldBe` 0 test $ f maxBound `Hspec.shouldBe` fromIntegral (maxBound :: Word) - Hspec.describe "Cast Word Natural" $ do - let f = Witch.cast @Word @Natural.Natural + Hspec.describe "From Word Natural" $ do + let f = Witch.from @Word @Natural.Natural test $ f 0 `Hspec.shouldBe` 0 test $ f maxBound `Hspec.shouldBe` fromIntegral (maxBound :: Word) @@ -981,8 +981,8 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ let x = maxBound :: Int in hush (Witch.tryCast @Word @Int (fromIntegral x)) `Hspec.shouldBe` Just x test $ let x = fromIntegral (maxBound :: Int) + 1 :: Word in hush (Witch.tryCast @Word @Int x) `Hspec.shouldBe` Nothing - Hspec.describe "Cast Word Integer" $ do - let f = Witch.cast @Word @Integer + Hspec.describe "From Word Integer" $ do + let f = Witch.from @Word @Integer test $ f 0 `Hspec.shouldBe` 0 test $ f maxBound `Hspec.shouldBe` fromIntegral (maxBound :: Word) @@ -1061,8 +1061,8 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ let x = maxBound :: Int in hush (Witch.tryCast @Natural.Natural @Int (fromIntegral x)) `Hspec.shouldBe` Just x test $ let x = fromIntegral (maxBound :: Int) + 1 :: Natural.Natural in hush (Witch.tryCast @Natural.Natural @Int x) `Hspec.shouldBe` Nothing - Hspec.describe "Cast Natural Integer" $ do - let f = Witch.cast @Natural.Natural @Integer + Hspec.describe "From Natural Integer" $ do + let f = Witch.from @Natural.Natural @Integer test $ f 0 `Hspec.shouldBe` 0 test $ f 9223372036854775808 `Hspec.shouldBe` 9223372036854775808 @@ -1214,8 +1214,8 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f (1 / 0) `Hspec.shouldBe` Nothing test $ f (-1 / 0) `Hspec.shouldBe` Nothing - Hspec.describe "Cast Float Double" $ do - let f = Witch.cast @Float @Double + Hspec.describe "From Float Double" $ do + let f = Witch.from @Float @Double test $ f 0 `Hspec.shouldBe` 0 test $ f 0.5 `Hspec.shouldBe` 0.5 test $ f (-0.5) `Hspec.shouldBe` (-0.5) @@ -1361,8 +1361,8 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f (1 / 0) `Hspec.shouldBe` Nothing test $ f (-1 / 0) `Hspec.shouldBe` Nothing - Hspec.describe "Cast Double Float" $ do - let f = Witch.cast @Double @Float + Hspec.describe "From Double Float" $ do + let f = Witch.from @Double @Float test $ f 0 `Hspec.shouldBe` 0 test $ f 0.5 `Hspec.shouldBe` 0.5 test $ f (-0.5) `Hspec.shouldBe` (-0.5) @@ -1372,9 +1372,9 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do -- Ratio - Hspec.describe "Cast a (Ratio a)" $ do - test $ Witch.cast @Integer @Rational 0 `Hspec.shouldBe` 0 - let f = Witch.cast @Int @(Ratio.Ratio Int) + Hspec.describe "From a (Ratio a)" $ do + test $ Witch.from @Integer @Rational 0 `Hspec.shouldBe` 0 + let f = Witch.from @Int @(Ratio.Ratio Int) test $ f 0 `Hspec.shouldBe` 0 Hspec.describe "TryCast (Ratio a) a" $ do @@ -1384,35 +1384,35 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f 0 `Hspec.shouldBe` Just 0 test $ f 0.5 `Hspec.shouldBe` Nothing - Hspec.describe "Cast Rational Float" $ do - let f = Witch.cast @Rational @Float + Hspec.describe "From Rational Float" $ do + let f = Witch.from @Rational @Float test $ f 0 `Hspec.shouldBe` 0 test $ f 0.5 `Hspec.shouldBe` 0.5 test $ f (-0.5) `Hspec.shouldBe` (-0.5) - Hspec.describe "Cast Rational Double" $ do - let f = Witch.cast @Rational @Double + Hspec.describe "From Rational Double" $ do + let f = Witch.from @Rational @Double test $ f 0 `Hspec.shouldBe` 0 test $ f 0.5 `Hspec.shouldBe` 0.5 test $ f (-0.5) `Hspec.shouldBe` (-0.5) -- Fixed - Hspec.describe "Cast Integer (Fixed a)" $ do - test $ Witch.cast @Integer @Fixed.Uni 1 `Hspec.shouldBe` 1 - let f = Witch.cast @Integer @Fixed.Deci + Hspec.describe "From Integer (Fixed a)" $ do + test $ Witch.from @Integer @Fixed.Uni 1 `Hspec.shouldBe` 1 + let f = Witch.from @Integer @Fixed.Deci test $ f 1 `Hspec.shouldBe` 0.1 - Hspec.describe "Cast (Fixed a) Integer" $ do - test $ Witch.cast @Fixed.Uni @Integer 1 `Hspec.shouldBe` 1 - let f = Witch.cast @Fixed.Deci @Integer + Hspec.describe "From (Fixed a) Integer" $ do + test $ Witch.from @Fixed.Uni @Integer 1 `Hspec.shouldBe` 1 + let f = Witch.from @Fixed.Deci @Integer test $ f 1 `Hspec.shouldBe` 10 -- Complex - Hspec.describe "Cast a (Complex a)" $ do - test $ Witch.cast @Double @(Complex.Complex Double) 1 `Hspec.shouldBe` 1 - let f = Witch.cast @Float @(Complex.Complex Float) + Hspec.describe "From a (Complex a)" $ do + test $ Witch.from @Double @(Complex.Complex Double) 1 `Hspec.shouldBe` 1 + let f = Witch.from @Float @(Complex.Complex Float) test $ f 1 `Hspec.shouldBe` 1 Hspec.describe "TryCast (Complex a) a" $ do @@ -1430,106 +1430,106 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do test $ f [1] `Hspec.shouldBe` Just (1 NonEmpty.:| []) test $ f [1, 2] `Hspec.shouldBe` Just (1 NonEmpty.:| [2]) - Hspec.describe "Cast (NonEmpty a) [a]" $ do - let f = Witch.cast @(NonEmpty.NonEmpty Int) @[Int] + Hspec.describe "From (NonEmpty a) [a]" $ do + let f = Witch.from @(NonEmpty.NonEmpty Int) @[Int] test $ f (1 NonEmpty.:| []) `Hspec.shouldBe` [1] test $ f (1 NonEmpty.:| [2]) `Hspec.shouldBe` [1, 2] -- Set - Hspec.describe "Cast [a] (Set a)" $ do - let f = Witch.cast @[Char] @(Set.Set Char) + Hspec.describe "From [a] (Set a)" $ do + let f = Witch.from @[Char] @(Set.Set Char) test $ f [] `Hspec.shouldBe` Set.fromList [] test $ f ['a'] `Hspec.shouldBe` Set.fromList ['a'] test $ f ['a', 'b'] `Hspec.shouldBe` Set.fromList ['a', 'b'] test $ f ['a', 'a'] `Hspec.shouldBe` Set.fromList ['a'] - Hspec.describe "Cast (Set a) [a]" $ do - let f = Witch.cast @(Set.Set Char) @[Char] + Hspec.describe "From (Set a) [a]" $ do + let f = Witch.from @(Set.Set Char) @[Char] test $ f (Set.fromList []) `Hspec.shouldBe` [] test $ f (Set.fromList ['a']) `Hspec.shouldBe` ['a'] test $ f (Set.fromList ['a', 'b']) `Hspec.shouldBe` ['a', 'b'] -- IntSet - Hspec.describe "Cast [Int] IntSet" $ do - let f = Witch.cast @[Int] @IntSet.IntSet + Hspec.describe "From [Int] IntSet" $ do + let f = Witch.from @[Int] @IntSet.IntSet test $ f [] `Hspec.shouldBe` IntSet.fromList [] test $ f [1] `Hspec.shouldBe` IntSet.fromList [1] test $ f [1, 2] `Hspec.shouldBe` IntSet.fromList [1, 2] - Hspec.describe "Cast IntSet [Int]" $ do - let f = Witch.cast @IntSet.IntSet @[Int] + Hspec.describe "From IntSet [Int]" $ do + let f = Witch.from @IntSet.IntSet @[Int] test $ f (IntSet.fromList []) `Hspec.shouldBe` [] test $ f (IntSet.fromList [1]) `Hspec.shouldBe` [1] test $ f (IntSet.fromList [1, 2]) `Hspec.shouldBe` [1, 2] -- Map - Hspec.describe "Cast [(k, v)] (Map k v)" $ do - let f = Witch.cast @[(Char, Int)] @(Map.Map Char Int) + Hspec.describe "From [(k, v)] (Map k v)" $ do + let f = Witch.from @[(Char, Int)] @(Map.Map Char Int) test $ f [] `Hspec.shouldBe` Map.empty test $ f [('a', 1)] `Hspec.shouldBe` Map.fromList [('a', 1)] test $ f [('a', 1), ('b', 2)] `Hspec.shouldBe` Map.fromList [('a', 1), ('b', 2)] test $ f [('a', 1), ('a', 2)] `Hspec.shouldBe` Map.fromList [('a', 2)] - Hspec.describe "Cast (Map k v) [(k, v)]" $ do - let f = Witch.cast @(Map.Map Char Int) @[(Char, Int)] + Hspec.describe "From (Map k v) [(k, v)]" $ do + let f = Witch.from @(Map.Map Char Int) @[(Char, Int)] test $ f Map.empty `Hspec.shouldBe` [] test $ f (Map.fromList [('a', 1)]) `Hspec.shouldBe` [('a', 1)] test $ f (Map.fromList [('a', 1), ('b', 2)]) `Hspec.shouldBe` [('a', 1), ('b', 2)] -- IntMap - Hspec.describe "Cast [(Int, v)] (IntMap v)" $ do - let f = Witch.cast @[(Int, Char)] @(IntMap.IntMap Char) + Hspec.describe "From [(Int, v)] (IntMap v)" $ do + let f = Witch.from @[(Int, Char)] @(IntMap.IntMap Char) test $ f [] `Hspec.shouldBe` IntMap.fromList [] test $ f [(1, 'a')] `Hspec.shouldBe` IntMap.fromList [(1, 'a')] test $ f [(1, 'a'), (2, 'b')] `Hspec.shouldBe` IntMap.fromList [(1, 'a'), (2, 'b')] test $ f [(1, 'a'), (1, 'b')] `Hspec.shouldBe` IntMap.fromList [(1, 'b')] - Hspec.describe "Cast (IntMap v) [(Int, v)]" $ do - let f = Witch.cast @(IntMap.IntMap Char) @[(Int, Char)] + Hspec.describe "From (IntMap v) [(Int, v)]" $ do + let f = Witch.from @(IntMap.IntMap Char) @[(Int, Char)] test $ f (IntMap.fromList []) `Hspec.shouldBe` [] test $ f (IntMap.fromList [(1, 'a')]) `Hspec.shouldBe` [(1, 'a')] test $ f (IntMap.fromList [(1, 'a'), (2, 'b')]) `Hspec.shouldBe` [(1, 'a'), (2, 'b')] -- Seq - Hspec.describe "Cast [a] (Seq a)" $ do - let f = Witch.cast @[Int] @(Seq.Seq Int) + Hspec.describe "From [a] (Seq a)" $ do + let f = Witch.from @[Int] @(Seq.Seq Int) test $ f [] `Hspec.shouldBe` Seq.fromList [] test $ f [1] `Hspec.shouldBe` Seq.fromList [1] test $ f [1, 2] `Hspec.shouldBe` Seq.fromList [1, 2] - Hspec.describe "Cast (Seq a) [a]" $ do - let f = Witch.cast @(Seq.Seq Int) @[Int] + Hspec.describe "From (Seq a) [a]" $ do + let f = Witch.from @(Seq.Seq Int) @[Int] test $ f (Seq.fromList []) `Hspec.shouldBe` [] test $ f (Seq.fromList [1]) `Hspec.shouldBe` [1] test $ f (Seq.fromList [1, 2]) `Hspec.shouldBe` [1, 2] -- ByteString - Hspec.describe "Cast [Word8] ByteString" $ do - let f = Witch.cast @[Word.Word8] @ByteString.ByteString + Hspec.describe "From [Word8] ByteString" $ do + let f = Witch.from @[Word.Word8] @ByteString.ByteString test $ f [] `Hspec.shouldBe` ByteString.pack [] test $ f [0x00] `Hspec.shouldBe` ByteString.pack [0x00] test $ f [0x0f, 0xf0] `Hspec.shouldBe` ByteString.pack [0x0f, 0xf0] - Hspec.describe "Cast ByteString [Word8]" $ do - let f = Witch.cast @ByteString.ByteString @[Word.Word8] + Hspec.describe "From ByteString [Word8]" $ do + let f = Witch.from @ByteString.ByteString @[Word.Word8] test $ f (ByteString.pack []) `Hspec.shouldBe` [] test $ f (ByteString.pack [0x00]) `Hspec.shouldBe` [0x00] test $ f (ByteString.pack [0x0f, 0xf0]) `Hspec.shouldBe` [0x0f, 0xf0] - Hspec.describe "Cast ByteString LazyByteString" $ do - let f = Witch.cast @ByteString.ByteString @LazyByteString.ByteString + Hspec.describe "From ByteString LazyByteString" $ do + let f = Witch.from @ByteString.ByteString @LazyByteString.ByteString test $ f (ByteString.pack []) `Hspec.shouldBe` LazyByteString.pack [] test $ f (ByteString.pack [0x00]) `Hspec.shouldBe` LazyByteString.pack [0x00] test $ f (ByteString.pack [0x0f, 0xf0]) `Hspec.shouldBe` LazyByteString.pack [0x0f, 0xf0] - Hspec.describe "Cast ByteString ShortByteString" $ do - let f = Witch.cast @ByteString.ByteString @ShortByteString.ShortByteString + Hspec.describe "From ByteString ShortByteString" $ do + let f = Witch.from @ByteString.ByteString @ShortByteString.ShortByteString test $ f (ByteString.pack []) `Hspec.shouldBe` ShortByteString.pack [] test $ f (ByteString.pack [0x00]) `Hspec.shouldBe` ShortByteString.pack [0x00] test $ f (ByteString.pack [0x0f, 0xf0]) `Hspec.shouldBe` ShortByteString.pack [0x0f, 0xf0] @@ -1542,20 +1542,20 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do -- LazyByteString - Hspec.describe "Cast [Word8] LazyByteString" $ do - let f = Witch.cast @[Word.Word8] @LazyByteString.ByteString + Hspec.describe "From [Word8] LazyByteString" $ do + let f = Witch.from @[Word.Word8] @LazyByteString.ByteString test $ f [] `Hspec.shouldBe` LazyByteString.pack [] test $ f [0x00] `Hspec.shouldBe` LazyByteString.pack [0x00] test $ f [0x0f, 0xf0] `Hspec.shouldBe` LazyByteString.pack [0x0f, 0xf0] - Hspec.describe "Cast LazyByteString [Word8]" $ do - let f = Witch.cast @LazyByteString.ByteString @[Word.Word8] + Hspec.describe "From LazyByteString [Word8]" $ do + let f = Witch.from @LazyByteString.ByteString @[Word.Word8] test $ f (LazyByteString.pack []) `Hspec.shouldBe` [] test $ f (LazyByteString.pack [0x00]) `Hspec.shouldBe` [0x00] test $ f (LazyByteString.pack [0x0f, 0xf0]) `Hspec.shouldBe` [0x0f, 0xf0] - Hspec.describe "Cast LazyByteString ByteString" $ do - let f = Witch.cast @LazyByteString.ByteString @ByteString.ByteString + Hspec.describe "From LazyByteString ByteString" $ do + let f = Witch.from @LazyByteString.ByteString @ByteString.ByteString test $ f (LazyByteString.pack []) `Hspec.shouldBe` ByteString.pack [] test $ f (LazyByteString.pack [0x00]) `Hspec.shouldBe` ByteString.pack [0x00] test $ f (LazyByteString.pack [0x0f, 0xf0]) `Hspec.shouldBe` ByteString.pack [0x0f, 0xf0] @@ -1568,90 +1568,90 @@ main = Hspec.hspec . Hspec.describe "Witch" $ do -- ShortByteString - Hspec.describe "Cast [Word8] ShortByteString" $ do - let f = Witch.cast @[Word.Word8] @ShortByteString.ShortByteString + Hspec.describe "From [Word8] ShortByteString" $ do + let f = Witch.from @[Word.Word8] @ShortByteString.ShortByteString test $ f [] `Hspec.shouldBe` ShortByteString.pack [] test $ f [0x00] `Hspec.shouldBe` ShortByteString.pack [0x00] test $ f [0x0f, 0xf0] `Hspec.shouldBe` ShortByteString.pack [0x0f, 0xf0] - Hspec.describe "Cast ShortByteString [Word8]" $ do - let f = Witch.cast @ShortByteString.ShortByteString @[Word.Word8] + Hspec.describe "From ShortByteString [Word8]" $ do + let f = Witch.from @ShortByteString.ShortByteString @[Word.Word8] test $ f (ShortByteString.pack []) `Hspec.shouldBe` [] test $ f (ShortByteString.pack [0x00]) `Hspec.shouldBe` [0x00] test $ f (ShortByteString.pack [0x0f, 0xf0]) `Hspec.shouldBe` [0x0f, 0xf0] - Hspec.describe "Cast ShortByteString ByteString" $ do - let f = Witch.cast @ShortByteString.ShortByteString @ByteString.ByteString + Hspec.describe "From ShortByteString ByteString" $ do + let f = Witch.from @ShortByteString.ShortByteString @ByteString.ByteString test $ f (ShortByteString.pack []) `Hspec.shouldBe` ByteString.pack [] test $ f (ShortByteString.pack [0x00]) `Hspec.shouldBe` ByteString.pack [0x00] test $ f (ShortByteString.pack [0x0f, 0xf0]) `Hspec.shouldBe` ByteString.pack [0x0f, 0xf0] -- Text - Hspec.describe "Cast String Text" $ do - let f = Witch.cast @String @Text.Text + Hspec.describe "From String Text" $ do + let f = Witch.from @String @Text.Text test $ f "" `Hspec.shouldBe` Text.pack "" test $ f "a" `Hspec.shouldBe` Text.pack "a" test $ f "ab" `Hspec.shouldBe` Text.pack "ab" - Hspec.describe "Cast Text String" $ do - let f = Witch.cast @Text.Text @String + Hspec.describe "From Text String" $ do + let f = Witch.from @Text.Text @String test $ f (Text.pack "") `Hspec.shouldBe` "" test $ f (Text.pack "a") `Hspec.shouldBe` "a" test $ f (Text.pack "ab") `Hspec.shouldBe` "ab" - Hspec.describe "Cast Text LazyText" $ do - let f = Witch.cast @Text.Text @LazyText.Text + Hspec.describe "From Text LazyText" $ do + let f = Witch.from @Text.Text @LazyText.Text test $ f (Text.pack "") `Hspec.shouldBe` LazyText.pack "" test $ f (Text.pack "a") `Hspec.shouldBe` LazyText.pack "a" test $ f (Text.pack "ab") `Hspec.shouldBe` LazyText.pack "ab" - Hspec.describe "Cast Text ByteString" $ do - let f = Witch.cast @Text.Text @ByteString.ByteString + Hspec.describe "From Text ByteString" $ do + let f = Witch.from @Text.Text @ByteString.ByteString test $ f (Text.pack "") `Hspec.shouldBe` ByteString.pack [] test $ f (Text.pack "a") `Hspec.shouldBe` ByteString.pack [0x61] -- LazyText - Hspec.describe "Cast String LazyText" $ do - let f = Witch.cast @String @LazyText.Text + Hspec.describe "From String LazyText" $ do + let f = Witch.from @String @LazyText.Text test $ f "" `Hspec.shouldBe` LazyText.pack "" test $ f "a" `Hspec.shouldBe` LazyText.pack "a" test $ f "ab" `Hspec.shouldBe` LazyText.pack "ab" - Hspec.describe "Cast LazyText String" $ do - let f = Witch.cast @LazyText.Text @String + Hspec.describe "From LazyText String" $ do + let f = Witch.from @LazyText.Text @String test $ f (LazyText.pack "") `Hspec.shouldBe` "" test $ f (LazyText.pack "a") `Hspec.shouldBe` "a" test $ f (LazyText.pack "ab") `Hspec.shouldBe` "ab" - Hspec.describe "Cast LazyText Text" $ do - let f = Witch.cast @LazyText.Text @Text.Text + Hspec.describe "From LazyText Text" $ do + let f = Witch.from @LazyText.Text @Text.Text test $ f (LazyText.pack "") `Hspec.shouldBe` Text.pack "" test $ f (LazyText.pack "a") `Hspec.shouldBe` Text.pack "a" test $ f (LazyText.pack "ab") `Hspec.shouldBe` Text.pack "ab" - Hspec.describe "Cast LazyText LazyByteString" $ do - let f = Witch.cast @LazyText.Text @LazyByteString.ByteString + Hspec.describe "From LazyText LazyByteString" $ do + let f = Witch.from @LazyText.Text @LazyByteString.ByteString test $ f (LazyText.pack "") `Hspec.shouldBe` LazyByteString.pack [] test $ f (LazyText.pack "a") `Hspec.shouldBe` LazyByteString.pack [0x61] -- TryCastException - Hspec.describe "Cast (TryCastException s t0) (TryCastException s t1)" $ do + Hspec.describe "From (TryCastException s t0) (TryCastException s t1)" $ do Hspec.it "needs tests" Hspec.pending - Hspec.describe "Cast (TryCastException s t) String" $ do - test $ Witch.cast (Witch.TryCastException Nothing Nothing :: Witch.TryCastException (Maybe Bool) (Maybe Int)) `Hspec.shouldBe` "TryCastException @(Maybe Bool) @(Maybe Int) Nothing Nothing" - let f = Witch.cast @(Witch.TryCastException Bool Int) @String + Hspec.describe "From (TryCastException s t) String" $ do + test $ Witch.from (Witch.TryCastException Nothing Nothing :: Witch.TryCastException (Maybe Bool) (Maybe Int)) `Hspec.shouldBe` "TryCastException @(Maybe Bool) @(Maybe Int) Nothing Nothing" + let f = Witch.from @(Witch.TryCastException Bool Int) @String test $ f (Witch.TryCastException False Nothing) `Hspec.shouldBe` "TryCastException @Bool @Int False Nothing" - Hspec.describe "Cast (TryCastException s t) Text" $ do - let f = Witch.cast @(Witch.TryCastException Bool Int) @Text.Text + Hspec.describe "From (TryCastException s t) Text" $ do + let f = Witch.from @(Witch.TryCastException Bool Int) @Text.Text test $ f (Witch.TryCastException False Nothing) `Hspec.shouldBe` Text.pack "TryCastException @Bool @Int False Nothing" - Hspec.describe "Cast (TryCastException s t) LazyText" $ do - let f = Witch.cast @(Witch.TryCastException Bool Int) @LazyText.Text + Hspec.describe "From (TryCastException s t) LazyText" $ do + let f = Witch.from @(Witch.TryCastException Bool Int) @LazyText.Text test $ f (Witch.TryCastException False Nothing) `Hspec.shouldBe` LazyText.pack "TryCastException @Bool @Int False Nothing" test :: Hspec.Example a => a -> Hspec.SpecWith (Hspec.Arg a) @@ -1673,6 +1673,6 @@ newtype Age = Age Int.Int8 deriving (Eq, Show) -instance Witch.Cast Age Int.Int8 +instance Witch.From Age Int.Int8 -instance Witch.Cast Int.Int8 Age +instance Witch.From Int.Int8 Age diff --git a/witch.cabal b/witch.cabal index 4def916..97c3536 100644 --- a/witch.cabal +++ b/witch.cabal @@ -46,7 +46,7 @@ library , template-haskell >= 2.15.0 && < 2.18 exposed-modules: Witch - Witch.Cast + Witch.From Witch.Instances Witch.Lift Witch.TryCast