-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Create NonEmpty version of any container
--   
--   Create NonEmpty version of any container.
@package nonempty-wrapper
@version 0.1.0.0


-- | Create NonEmpty version of any container.
module Data.NonEmpty

-- | NonEmpty proofed value.
data NonEmpty a

-- | Extract the NonEmpty proven value
($sel:getNonEmpty:NonEmpty) :: NonEmpty a -> a

-- | Trusted value
trustedNonEmpty :: a -> NonEmpty a

-- | Singleton constructible value
class NonEmptySingleton a where {
    type family NonEmptySingletonElement a :: Type;
}
nonEmptySingleton :: NonEmptySingleton a => Proxy a -> NonEmptySingletonElement a -> a

-- | Build a <a>NonEmpty</a> value from a singleton value
singleton :: NonEmptySingleton a => Proxy a -> NonEmptySingletonElement a -> NonEmpty a

-- | Build <a>NonEmptySingleton</a> for <a>Applicative</a> defined types to
--   be used with <tt>DerivingVia</tt>:
--   
--   <pre>
--   deriving instance NonEmptySingleton [a] via (MkNonEmptySingletonApplicative [a])
--   </pre>
newtype MkNonEmptySingletonApplicative a
MkNonEmptySingletonApplicative :: a -> MkNonEmptySingletonApplicative a

-- | Used to attempt conversion from possibly empty to <a>NonEmpty</a>.
class NonEmptyFromContainer a
isNonEmpty :: NonEmptyFromContainer a => a -> Bool

-- | Attempt <a>NonEmpty</a> proof
nonEmpty :: NonEmptyFromContainer a => a -> Maybe (NonEmpty a)

-- | Build <a>MkNonEmptyFromContainerFoldable</a> for <a>Foldable</a>
--   defined types to be used with <tt>DerivingVia</tt>:
--   
--   <pre>
--   deriving instance NonEmptyFromContainer [a] via (MkNonEmptyFromContainerFoldable [a])
--   </pre>
newtype MkNonEmptyFromContainerFoldable a
MkNonEmptyFromContainerFoldable :: a -> MkNonEmptyFromContainerFoldable a

-- | Append empty container
(<|) :: Semigroup a => NonEmpty a -> a -> NonEmpty a
infixr 6 <|

-- | Prepend empty container
(|>) :: Semigroup a => a -> NonEmpty a -> NonEmpty a
infixr 6 |>

-- | Wrap and unwrap <a>NonEmpty</a> (unsafe, be sure <tt>f</tt> is
--   size-conservative)
overNonEmpty :: (a -> b) -> NonEmpty a -> NonEmpty b

-- | Wrap and unwrap <a>NonEmpty</a> (unsafe, be sure <tt>f</tt> is
--   size-conservative)
overNonEmpty2 :: (a -> b -> c) -> NonEmpty a -> NonEmpty b -> NonEmpty c

-- | Wrap and unwrap <a>NonEmpty</a> (unsafe, be sure <tt>f</tt> is
--   size-conservative)
overNonEmpty3 :: (a -> b -> c -> d) -> NonEmpty a -> NonEmpty b -> NonEmpty c -> NonEmpty d

-- | Wrap and unwrap <a>NonEmpty</a> (unsafe, be sure <tt>f</tt> is
--   size-conservative)
overNonEmpty4 :: (a -> b -> c -> d -> e) -> NonEmpty a -> NonEmpty b -> NonEmpty c -> NonEmpty d -> NonEmpty e

-- | Wrap and unwrap <a>NonEmpty</a> (unsafe, be sure <tt>f</tt> is
--   size-conservative)
overNonEmpty5 :: (a -> b -> c -> d -> e -> f) -> NonEmpty a -> NonEmpty b -> NonEmpty c -> NonEmpty d -> NonEmpty e -> NonEmpty f

-- | <a>fmap</a> over a <a>NonEmpty</a> container
fmapNonEmpty :: Functor f => (a -> b) -> NonEmpty (f a) -> NonEmpty (f b)

-- | Apply an unsafe function over empty, which is safe over
--   <a>NonEmpty</a>
withNonEmpty :: (a -> Maybe b) -> NonEmpty a -> b
instance GHC.Show.Show a => GHC.Show.Show (Data.NonEmpty.NonEmpty a)
instance GHC.Classes.Ord a => GHC.Classes.Ord (Data.NonEmpty.NonEmpty a)
instance GHC.Classes.Eq a => GHC.Classes.Eq (Data.NonEmpty.NonEmpty a)
instance Data.Foldable.Foldable f => Data.NonEmpty.NonEmptyFromContainer (f a)
instance GHC.Base.Applicative f => Data.NonEmpty.NonEmptySingleton (f a)
instance GHC.Base.Semigroup a => GHC.Base.Semigroup (Data.NonEmpty.NonEmpty a)