-- --< Header >-- {{{

{-# LANGUAGE TypeFamilies #-}

{- |

Description : A higher-kinded t'Data.Void.Void'.
Copyright   : (c) L. S. Leary, 2025

A higher-kinded t'Data.Void.Void'.
Dual to t'Data.Proxy.Proxy'.

-}

-- }}}

-- --< Imports & Exports >-- {{{

module Data.Hetero.Void (

  -- * VoidF
  VoidF,
  absurdF,
  vacuousF,

) where

-- heterogeneous-comparison
import Data.Hetero.Role (RoleKind(Nominal))
import Data.Hetero.Eq (HetEq(..))
import Data.Hetero.Ord (HetOrd(..))

-- }}}

-- --< VoidF >-- {{{

-- | A higher-kinded t'Data.Void.Void'.
--   Dual to t'Data.Proxy.Proxy'.
data VoidF a
  deriving (VoidF a -> VoidF a -> Bool
(VoidF a -> VoidF a -> Bool)
-> (VoidF a -> VoidF a -> Bool) -> Eq (VoidF a)
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
forall k (a :: k). VoidF a -> VoidF a -> Bool
$c== :: forall k (a :: k). VoidF a -> VoidF a -> Bool
== :: VoidF a -> VoidF a -> Bool
$c/= :: forall k (a :: k). VoidF a -> VoidF a -> Bool
/= :: VoidF a -> VoidF a -> Bool
Eq, Eq (VoidF a)
Eq (VoidF a) =>
(VoidF a -> VoidF a -> Ordering)
-> (VoidF a -> VoidF a -> Bool)
-> (VoidF a -> VoidF a -> Bool)
-> (VoidF a -> VoidF a -> Bool)
-> (VoidF a -> VoidF a -> Bool)
-> (VoidF a -> VoidF a -> VoidF a)
-> (VoidF a -> VoidF a -> VoidF a)
-> Ord (VoidF a)
VoidF a -> VoidF a -> Bool
VoidF a -> VoidF a -> Ordering
VoidF a -> VoidF a -> VoidF a
forall a.
Eq a =>
(a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
forall k (a :: k). Eq (VoidF a)
forall k (a :: k). VoidF a -> VoidF a -> Bool
forall k (a :: k). VoidF a -> VoidF a -> Ordering
forall k (a :: k). VoidF a -> VoidF a -> VoidF a
$ccompare :: forall k (a :: k). VoidF a -> VoidF a -> Ordering
compare :: VoidF a -> VoidF a -> Ordering
$c< :: forall k (a :: k). VoidF a -> VoidF a -> Bool
< :: VoidF a -> VoidF a -> Bool
$c<= :: forall k (a :: k). VoidF a -> VoidF a -> Bool
<= :: VoidF a -> VoidF a -> Bool
$c> :: forall k (a :: k). VoidF a -> VoidF a -> Bool
> :: VoidF a -> VoidF a -> Bool
$c>= :: forall k (a :: k). VoidF a -> VoidF a -> Bool
>= :: VoidF a -> VoidF a -> Bool
$cmax :: forall k (a :: k). VoidF a -> VoidF a -> VoidF a
max :: VoidF a -> VoidF a -> VoidF a
$cmin :: forall k (a :: k). VoidF a -> VoidF a -> VoidF a
min :: VoidF a -> VoidF a -> VoidF a
Ord, ReadPrec [VoidF a]
ReadPrec (VoidF a)
Int -> ReadS (VoidF a)
ReadS [VoidF a]
(Int -> ReadS (VoidF a))
-> ReadS [VoidF a]
-> ReadPrec (VoidF a)
-> ReadPrec [VoidF a]
-> Read (VoidF a)
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
forall k (a :: k). ReadPrec [VoidF a]
forall k (a :: k). ReadPrec (VoidF a)
forall k (a :: k). Int -> ReadS (VoidF a)
forall k (a :: k). ReadS [VoidF a]
$creadsPrec :: forall k (a :: k). Int -> ReadS (VoidF a)
readsPrec :: Int -> ReadS (VoidF a)
$creadList :: forall k (a :: k). ReadS [VoidF a]
readList :: ReadS [VoidF a]
$creadPrec :: forall k (a :: k). ReadPrec (VoidF a)
readPrec :: ReadPrec (VoidF a)
$creadListPrec :: forall k (a :: k). ReadPrec [VoidF a]
readListPrec :: ReadPrec [VoidF a]
Read, Int -> VoidF a -> ShowS
[VoidF a] -> ShowS
VoidF a -> String
(Int -> VoidF a -> ShowS)
-> (VoidF a -> String) -> ([VoidF a] -> ShowS) -> Show (VoidF a)
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
forall k (a :: k). Int -> VoidF a -> ShowS
forall k (a :: k). [VoidF a] -> ShowS
forall k (a :: k). VoidF a -> String
$cshowsPrec :: forall k (a :: k). Int -> VoidF a -> ShowS
showsPrec :: Int -> VoidF a -> ShowS
$cshow :: forall k (a :: k). VoidF a -> String
show :: VoidF a -> String
$cshowList :: forall k (a :: k). [VoidF a] -> ShowS
showList :: [VoidF a] -> ShowS
Show, (forall a b. (a -> b) -> VoidF a -> VoidF b)
-> (forall a b. a -> VoidF b -> VoidF a) -> Functor VoidF
forall a b. a -> VoidF b -> VoidF a
forall a b. (a -> b) -> VoidF a -> VoidF b
forall (f :: * -> *).
(forall a b. (a -> b) -> f a -> f b)
-> (forall a b. a -> f b -> f a) -> Functor f
$cfmap :: forall a b. (a -> b) -> VoidF a -> VoidF b
fmap :: forall a b. (a -> b) -> VoidF a -> VoidF b
$c<$ :: forall a b. a -> VoidF b -> VoidF a
<$ :: forall a b. a -> VoidF b -> VoidF a
Functor, (forall m. Monoid m => VoidF m -> m)
-> (forall m a. Monoid m => (a -> m) -> VoidF a -> m)
-> (forall m a. Monoid m => (a -> m) -> VoidF a -> m)
-> (forall a b. (a -> b -> b) -> b -> VoidF a -> b)
-> (forall a b. (a -> b -> b) -> b -> VoidF a -> b)
-> (forall b a. (b -> a -> b) -> b -> VoidF a -> b)
-> (forall b a. (b -> a -> b) -> b -> VoidF a -> b)
-> (forall a. (a -> a -> a) -> VoidF a -> a)
-> (forall a. (a -> a -> a) -> VoidF a -> a)
-> (forall a. VoidF a -> [a])
-> (forall a. VoidF a -> Bool)
-> (forall a. VoidF a -> Int)
-> (forall a. Eq a => a -> VoidF a -> Bool)
-> (forall a. Ord a => VoidF a -> a)
-> (forall a. Ord a => VoidF a -> a)
-> (forall a. Num a => VoidF a -> a)
-> (forall a. Num a => VoidF a -> a)
-> Foldable VoidF
forall a. Eq a => a -> VoidF a -> Bool
forall a. Num a => VoidF a -> a
forall a. Ord a => VoidF a -> a
forall m. Monoid m => VoidF m -> m
forall a. VoidF a -> Bool
forall a. VoidF a -> Int
forall a. VoidF a -> [a]
forall a. (a -> a -> a) -> VoidF a -> a
forall m a. Monoid m => (a -> m) -> VoidF a -> m
forall b a. (b -> a -> b) -> b -> VoidF a -> b
forall a b. (a -> b -> b) -> b -> VoidF a -> b
forall (t :: * -> *).
(forall m. Monoid m => t m -> m)
-> (forall m a. Monoid m => (a -> m) -> t a -> m)
-> (forall m a. Monoid m => (a -> m) -> t a -> m)
-> (forall a b. (a -> b -> b) -> b -> t a -> b)
-> (forall a b. (a -> b -> b) -> b -> t a -> b)
-> (forall b a. (b -> a -> b) -> b -> t a -> b)
-> (forall b a. (b -> a -> b) -> b -> t a -> b)
-> (forall a. (a -> a -> a) -> t a -> a)
-> (forall a. (a -> a -> a) -> t a -> a)
-> (forall a. t a -> [a])
-> (forall a. t a -> Bool)
-> (forall a. t a -> Int)
-> (forall a. Eq a => a -> t a -> Bool)
-> (forall a. Ord a => t a -> a)
-> (forall a. Ord a => t a -> a)
-> (forall a. Num a => t a -> a)
-> (forall a. Num a => t a -> a)
-> Foldable t
$cfold :: forall m. Monoid m => VoidF m -> m
fold :: forall m. Monoid m => VoidF m -> m
$cfoldMap :: forall m a. Monoid m => (a -> m) -> VoidF a -> m
foldMap :: forall m a. Monoid m => (a -> m) -> VoidF a -> m
$cfoldMap' :: forall m a. Monoid m => (a -> m) -> VoidF a -> m
foldMap' :: forall m a. Monoid m => (a -> m) -> VoidF a -> m
$cfoldr :: forall a b. (a -> b -> b) -> b -> VoidF a -> b
foldr :: forall a b. (a -> b -> b) -> b -> VoidF a -> b
$cfoldr' :: forall a b. (a -> b -> b) -> b -> VoidF a -> b
foldr' :: forall a b. (a -> b -> b) -> b -> VoidF a -> b
$cfoldl :: forall b a. (b -> a -> b) -> b -> VoidF a -> b
foldl :: forall b a. (b -> a -> b) -> b -> VoidF a -> b
$cfoldl' :: forall b a. (b -> a -> b) -> b -> VoidF a -> b
foldl' :: forall b a. (b -> a -> b) -> b -> VoidF a -> b
$cfoldr1 :: forall a. (a -> a -> a) -> VoidF a -> a
foldr1 :: forall a. (a -> a -> a) -> VoidF a -> a
$cfoldl1 :: forall a. (a -> a -> a) -> VoidF a -> a
foldl1 :: forall a. (a -> a -> a) -> VoidF a -> a
$ctoList :: forall a. VoidF a -> [a]
toList :: forall a. VoidF a -> [a]
$cnull :: forall a. VoidF a -> Bool
null :: forall a. VoidF a -> Bool
$clength :: forall a. VoidF a -> Int
length :: forall a. VoidF a -> Int
$celem :: forall a. Eq a => a -> VoidF a -> Bool
elem :: forall a. Eq a => a -> VoidF a -> Bool
$cmaximum :: forall a. Ord a => VoidF a -> a
maximum :: forall a. Ord a => VoidF a -> a
$cminimum :: forall a. Ord a => VoidF a -> a
minimum :: forall a. Ord a => VoidF a -> a
$csum :: forall a. Num a => VoidF a -> a
sum :: forall a. Num a => VoidF a -> a
$cproduct :: forall a. Num a => VoidF a -> a
product :: forall a. Num a => VoidF a -> a
Foldable, Functor VoidF
Foldable VoidF
(Functor VoidF, Foldable VoidF) =>
(forall (f :: * -> *) a b.
 Applicative f =>
 (a -> f b) -> VoidF a -> f (VoidF b))
-> (forall (f :: * -> *) a.
    Applicative f =>
    VoidF (f a) -> f (VoidF a))
-> (forall (m :: * -> *) a b.
    Monad m =>
    (a -> m b) -> VoidF a -> m (VoidF b))
-> (forall (m :: * -> *) a. Monad m => VoidF (m a) -> m (VoidF a))
-> Traversable VoidF
forall (t :: * -> *).
(Functor t, Foldable t) =>
(forall (f :: * -> *) a b.
 Applicative f =>
 (a -> f b) -> t a -> f (t b))
-> (forall (f :: * -> *) a. Applicative f => t (f a) -> f (t a))
-> (forall (m :: * -> *) a b.
    Monad m =>
    (a -> m b) -> t a -> m (t b))
-> (forall (m :: * -> *) a. Monad m => t (m a) -> m (t a))
-> Traversable t
forall (m :: * -> *) a. Monad m => VoidF (m a) -> m (VoidF a)
forall (f :: * -> *) a. Applicative f => VoidF (f a) -> f (VoidF a)
forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> VoidF a -> m (VoidF b)
forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> VoidF a -> f (VoidF b)
$ctraverse :: forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> VoidF a -> f (VoidF b)
traverse :: forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> VoidF a -> f (VoidF b)
$csequenceA :: forall (f :: * -> *) a. Applicative f => VoidF (f a) -> f (VoidF a)
sequenceA :: forall (f :: * -> *) a. Applicative f => VoidF (f a) -> f (VoidF a)
$cmapM :: forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> VoidF a -> m (VoidF b)
mapM :: forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> VoidF a -> m (VoidF b)
$csequence :: forall (m :: * -> *) a. Monad m => VoidF (m a) -> m (VoidF a)
sequence :: forall (m :: * -> *) a. Monad m => VoidF (m a) -> m (VoidF a)
Traversable)

instance HetEq VoidF where
  type Strength VoidF = Nominal
  heq :: forall (a :: k) (b :: k).
VoidF a -> VoidF b -> Maybe (AtLeast (Strength VoidF) a b)
heq = \case{}

instance HetOrd VoidF where
  hcompare :: forall (a :: k) (b :: k).
VoidF a -> VoidF b -> HetOrdering (Strength VoidF) a b
hcompare = \case{}

instance Semigroup (VoidF a) where
  <> :: VoidF a -> VoidF a -> VoidF a
(<>) = \case{}

absurdF :: VoidF a -> b
absurdF :: forall {k} (a :: k) b. VoidF a -> b
absurdF = \case{}

vacuousF :: Functor f => f (VoidF a) -> f b
vacuousF :: forall {k} (f :: * -> *) (a :: k) b.
Functor f =>
f (VoidF a) -> f b
vacuousF = (VoidF a -> b) -> f (VoidF a) -> f b
forall a b. (a -> b) -> f a -> f b
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap VoidF a -> b
forall {k} (a :: k) b. VoidF a -> b
absurdF

-- }}}