Hoogle Search

Within LTS Haskell 24.58 (ghc-9.10.3)

Note that Stackage only displays results for the latest LTS and Nightly snapshot. Learn more.

Exact lookup

1. getHeaders :: GetHeaders ls => ls -> [Header]

   servant	Servant.API

   No documentation available.

2. getHeadersHList :: Headers (ls :: [Type]) a -> HList ls

   servant	Servant.API

   HList of headers.

3. lookupResponseHeader :: forall (h :: Symbol) a (headers :: [Type]) r . HasResponseHeader h a headers => Headers headers r -> ResponseHeader h a

   servant	Servant.API

   Look up a specific ResponseHeader, without having to know what position it is in the HList.

   >>> let example1 = addHeader 5 "hi" :: Headers '[Header "someheader" Int] String
   
   >>> let example2 = addHeader True example1 :: Headers '[Header "1st" Bool, Header "someheader" Int] String
   
   >>> lookupResponseHeader example2 :: ResponseHeader "someheader" Int
   Header 5
   

   >>> lookupResponseHeader example2 :: ResponseHeader "1st" Bool
   Header True
   

   Usage of this function relies on an explicit type annotation of the header to be looked up. This can be done with type annotations on the result, or with an explicit type application. In this example, the type of header value is determined by the type-inference, we only specify the name of the header:

   >>> :set -XTypeApplications
   
   >>> case lookupResponseHeader @"1st" example2 of { Header b -> b ; _ -> False }
   True
   

4. noHeader :: forall (h :: Symbol) v orig new . AddHeader '[Optional, Strict] h v orig new => orig -> new

   servant	Servant.API

   Deliberately do not add a header to a value.

   >>> let example1 = noHeader "hi" :: Headers '[Header "someheader" Int] String
   
   >>> getHeaders example1
   []
   

5. noHeader' :: forall (mods :: [Type]) (h :: Symbol) v orig new . AddHeader mods h v orig new => orig -> new

   servant	Servant.API

   Same as noHeader but works with Header', so it's possible to use any mods.

6. parseHeader :: FromHttpApiData a => ByteString -> Either Text a

   servant	Servant.API

   Parse HTTP header value.

7. toHeader :: ToHttpApiData a => a -> ByteString

   servant	Servant.API

   Convert to HTTP header value.

8. newtype AcceptHeader

   servant	Servant.API.ContentTypes

   No documentation available.

9. AcceptHeader :: ByteString -> AcceptHeader

   servant	Servant.API.ContentTypes

   No documentation available.

10. class AsHeaders (headers :: [Type]) response returnType

    servant	Servant.API.MultiVerb

    This is used to convert a response containing headers to a custom type including the information in the headers. If you need to send a combination of headers and response that is not provided by Servant, you can cwrite your own instance. Take example on the ones provided.

Page 145 of many | Previous | Next