Overloaded.Numerals

Another way to desugar overloaded numeric literals. See FromNumeral.

Documentation

class FromNumeral (n :: Nat) a where

Another way to desugar numerals.

A numeric literal 123 is desugared to

fromNumeral @123

Enabled with:

{-# OPTIONS -fplugin=Overloaded -fplugin-opt=Overloaded:Numerals #-}

One can do type-level computations with this.

Methods

fromNumeral :: a

Instances

KnownNat n => FromNumeral n Nat

Defined in Overloaded.Numerals

Methods

fromNumeral :: Nat

(KnownNat n, OverflowCheck n "Word8" (n <=? 18446744073709551615)) => FromNumeral n Word64

Defined in Overloaded.Numerals

Methods

fromNumeral :: Word64

(KnownNat n, OverflowCheck n "Word8" (n <=? 4294967295)) => FromNumeral n Word32

Defined in Overloaded.Numerals

Methods

fromNumeral :: Word32

(KnownNat n, OverflowCheck n "Word8" (n <=? 65535)) => FromNumeral n Word16

Defined in Overloaded.Numerals

Methods

fromNumeral :: Word16

(KnownNat n, OverflowCheck n "Word8" (n <=? 255)) => FromNumeral n Word8

Defined in Overloaded.Numerals

Methods

fromNumeral :: Word8

KnownNat n => FromNumeral n Int

TODO: currently there is no range check

Defined in Overloaded.Numerals

Methods

fromNumeral :: Int

KnownNat n => FromNumeral n Integer

Defined in Overloaded.Numerals

Methods

fromNumeral :: Integer

KnownNat n => FromNumeral n Natural

Defined in Overloaded.Numerals

Methods

fromNumeral :: Natural

(FinFromNumeral (FromGHC n) m, IsLess (FromGHC n) m n (ToGHC m)) => FromNumeral n (Fin m)

Defined in Overloaded.Numerals

Methods

fromNumeral :: Fin m

defaultFromNumeral :: forall n a. (KnownNat n, Integral a) => a

Default implementation of fromNumeral.

Usage example:

instance (KnownNat n, ...) => FromNumeral n MyType where
    fromNumeral = defaultFromNumeral @n