Safe Haskell	Safe
Language	Haskell2010

Servant.API.Alternative

Synopsis

data a :<|> b = a :<|> b

Documentation

data a :<|> b infixr 3 Source #

Union of two APIs, first takes precedence in case of overlap.

Example:

>>> :{
type MyApi = "books" :> Get '[JSON] [Book] -- GET /books
       :<|> "books" :> ReqBody '[JSON] Book :> Post '[JSON] () -- POST /books
:}

Constructors

a :<|> b infixr 3

Instances

Functor ((:<\|>) a) Source #
Instance details Defined in Servant.API.Alternative Methods fmap :: (a0 -> b) -> (a :<\|> a0) -> a :<\|> b # (<$) :: a0 -> (a :<\|> b) -> a :<\|> a0 #
Foldable ((:<\|>) a) Source #
Instance details Defined in Servant.API.Alternative Methods fold :: Monoid m => (a :<\|> m) -> m # foldMap :: Monoid m => (a0 -> m) -> (a :<\|> a0) -> m # foldr :: (a0 -> b -> b) -> b -> (a :<\|> a0) -> b # foldr' :: (a0 -> b -> b) -> b -> (a :<\|> a0) -> b # foldl :: (b -> a0 -> b) -> b -> (a :<\|> a0) -> b # foldl' :: (b -> a0 -> b) -> b -> (a :<\|> a0) -> b # foldr1 :: (a0 -> a0 -> a0) -> (a :<\|> a0) -> a0 # foldl1 :: (a0 -> a0 -> a0) -> (a :<\|> a0) -> a0 # toList :: (a :<\|> a0) -> [a0] # null :: (a :<\|> a0) -> Bool # length :: (a :<\|> a0) -> Int # elem :: Eq a0 => a0 -> (a :<\|> a0) -> Bool # maximum :: Ord a0 => (a :<\|> a0) -> a0 # minimum :: Ord a0 => (a :<\|> a0) -> a0 # sum :: Num a0 => (a :<\|> a0) -> a0 # product :: Num a0 => (a :<\|> a0) -> a0 #
Traversable ((:<\|>) a) Source #
Instance details Defined in Servant.API.Alternative Methods traverse :: Applicative f => (a0 -> f b) -> (a :<\|> a0) -> f (a :<\|> b) # sequenceA :: Applicative f => (a :<\|> f a0) -> f (a :<\|> a0) # mapM :: Monad m => (a0 -> m b) -> (a :<\|> a0) -> m (a :<\|> b) # sequence :: Monad m => (a :<\|> m a0) -> m (a :<\|> a0) #
(HasLink a, HasLink b) => HasLink (a :<\|> b :: *) Source #
Instance details Defined in Servant.Links Associated Types type MkLink (a :<\|> b) a :: * Source # Methods toLink :: (Link -> a0) -> Proxy (a :<\|> b) -> Link -> MkLink (a :<\|> b) a0 Source #
(Bounded a, Bounded b) => Bounded (a :<\|> b) Source #
Instance details Defined in Servant.API.Alternative Methods minBound :: a :<\|> b # maxBound :: a :<\|> b #
(Eq a, Eq b) => Eq (a :<\|> b) Source #
Instance details Defined in Servant.API.Alternative Methods (==) :: (a :<\|> b) -> (a :<\|> b) -> Bool # (/=) :: (a :<\|> b) -> (a :<\|> b) -> Bool #
(Show a, Show b) => Show (a :<\|> b) Source #
Instance details Defined in Servant.API.Alternative Methods showsPrec :: Int -> (a :<\|> b) -> ShowS # show :: (a :<\|> b) -> String # showList :: [a :<\|> b] -> ShowS #
(Semigroup a, Semigroup b) => Semigroup (a :<\|> b) Source #
Instance details Defined in Servant.API.Alternative Methods (<>) :: (a :<\|> b) -> (a :<\|> b) -> a :<\|> b # sconcat :: NonEmpty (a :<\|> b) -> a :<\|> b # stimes :: Integral b0 => b0 -> (a :<\|> b) -> a :<\|> b #
(Monoid a, Monoid b) => Monoid (a :<\|> b) Source #
Instance details Defined in Servant.API.Alternative Methods mempty :: a :<\|> b # mappend :: (a :<\|> b) -> (a :<\|> b) -> a :<\|> b # mconcat :: [a :<\|> b] -> a :<\|> b #
(Enter typ1 m1 n1 ret1, Enter typ2 m2 n2 ret2, m1 ~ m2, n1 ~ n2, Entered m1 n1 (typ1 :<\|> typ2) ~ (ret1 :<\|> ret2), Entered n1 m1 (ret1 :<\|> ret2) ~ (typ1 :<\|> typ2)) => Enter (typ1 :<\|> typ2) m1 n1 (ret1 :<\|> ret2) Source #
Instance details Defined in Servant.Utils.Enter Methods enter :: (m1 :~> n1) -> (typ1 :<\|> typ2) -> ret1 :<\|> ret2 Source #
type MkLink (a :<\|> b :: *) r Source #
Instance details Defined in Servant.Links type MkLink (a :<\|> b :: *) r = MkLink a r :<\|> MkLink b r

Functor ((:<\|>) a) Source #
Instance details Defined in Servant.API.Alternative Methods fmap :: (a0 -> b) -> (a :<\|> a0) -> a :<\|> b # (<$) :: a0 -> (a :<\|> b) -> a :<\|> a0 #
Foldable ((:<\|>) a) Source #
Instance details Defined in Servant.API.Alternative Methods fold :: Monoid m => (a :<\|> m) -> m # foldMap :: Monoid m => (a0 -> m) -> (a :<\|> a0) -> m # foldr :: (a0 -> b -> b) -> b -> (a :<\|> a0) -> b # foldr' :: (a0 -> b -> b) -> b -> (a :<\|> a0) -> b # foldl :: (b -> a0 -> b) -> b -> (a :<\|> a0) -> b # foldl' :: (b -> a0 -> b) -> b -> (a :<\|> a0) -> b # foldr1 :: (a0 -> a0 -> a0) -> (a :<\|> a0) -> a0 # foldl1 :: (a0 -> a0 -> a0) -> (a :<\|> a0) -> a0 # toList :: (a :<\|> a0) -> [a0] # null :: (a :<\|> a0) -> Bool # length :: (a :<\|> a0) -> Int # elem :: Eq a0 => a0 -> (a :<\|> a0) -> Bool # maximum :: Ord a0 => (a :<\|> a0) -> a0 # minimum :: Ord a0 => (a :<\|> a0) -> a0 # sum :: Num a0 => (a :<\|> a0) -> a0 # product :: Num a0 => (a :<\|> a0) -> a0 #
Traversable ((:<\|>) a) Source #
Instance details Defined in Servant.API.Alternative Methods traverse :: Applicative f => (a0 -> f b) -> (a :<\|> a0) -> f (a :<\|> b) # sequenceA :: Applicative f => (a :<\|> f a0) -> f (a :<\|> a0) # mapM :: Monad m => (a0 -> m b) -> (a :<\|> a0) -> m (a :<\|> b) # sequence :: Monad m => (a :<\|> m a0) -> m (a :<\|> a0) #
(HasLink a, HasLink b) => HasLink (a :<\|> b :: *) Source #
Instance details Defined in Servant.Links Associated Types type MkLink (a :<\|> b) a :: * Source # Methods toLink :: (Link -> a0) -> Proxy (a :<\|> b) -> Link -> MkLink (a :<\|> b) a0 Source #
(Bounded a, Bounded b) => Bounded (a :<\|> b) Source #
Instance details Defined in Servant.API.Alternative Methods minBound :: a :<\|> b # maxBound :: a :<\|> b #
(Eq a, Eq b) => Eq (a :<\|> b) Source #
Instance details Defined in Servant.API.Alternative Methods (==) :: (a :<\|> b) -> (a :<\|> b) -> Bool # (/=) :: (a :<\|> b) -> (a :<\|> b) -> Bool #
(Show a, Show b) => Show (a :<\|> b) Source #
Instance details Defined in Servant.API.Alternative Methods showsPrec :: Int -> (a :<\|> b) -> ShowS # show :: (a :<\|> b) -> String # showList :: [a :<\|> b] -> ShowS #
(Semigroup a, Semigroup b) => Semigroup (a :<\|> b) Source #
Instance details Defined in Servant.API.Alternative Methods (<>) :: (a :<\|> b) -> (a :<\|> b) -> a :<\|> b # sconcat :: NonEmpty (a :<\|> b) -> a :<\|> b # stimes :: Integral b0 => b0 -> (a :<\|> b) -> a :<\|> b #
(Monoid a, Monoid b) => Monoid (a :<\|> b) Source #
Instance details Defined in Servant.API.Alternative Methods mempty :: a :<\|> b # mappend :: (a :<\|> b) -> (a :<\|> b) -> a :<\|> b # mconcat :: [a :<\|> b] -> a :<\|> b #
(Enter typ1 m1 n1 ret1, Enter typ2 m2 n2 ret2, m1 ~ m2, n1 ~ n2, Entered m1 n1 (typ1 :<\|> typ2) ~ (ret1 :<\|> ret2), Entered n1 m1 (ret1 :<\|> ret2) ~ (typ1 :<\|> typ2)) => Enter (typ1 :<\|> typ2) m1 n1 (ret1 :<\|> ret2) Source #
Instance details Defined in Servant.Utils.Enter Methods enter :: (m1 :~> n1) -> (typ1 :<\|> typ2) -> ret1 :<\|> ret2 Source #
type MkLink (a :<\|> b :: *) r Source #
Instance details Defined in Servant.Links type MkLink (a :<\|> b :: *) r = MkLink a r :<\|> MkLink b r