Dormouse.Client

The Client module is the primary module you will need to import to perform HTTP requests with this library.

For a comprehensive documentation, please see: https://dormouse.io/client.html

Request / Response Types

data HttpRequest url method body contentTag acceptTag

Model of an HTTP request with type parameters: scheme describing the uri scheme, body describing the type of the content body, contentTag describing the type, method describing the HTTP verb associated with the request, contentTag describing the type of content being sen and acceptTag describing the type of content desired

Constructors

HttpRequest

Fields

• requestMethod :: !(HttpMethod method)
• requestUrl :: !url
• requestHeaders :: Map HeaderName ByteString
• requestBody :: body

Instances

(Eq body, Eq url) => Eq (HttpRequest url method body contentTag acceptTag)

Defined in Dormouse.Client.Types

Methods

(==) :: HttpRequest url method body contentTag acceptTag -> HttpRequest url method body contentTag acceptTag -> Bool

(/=) :: HttpRequest url method body contentTag acceptTag -> HttpRequest url method body contentTag acceptTag -> Bool

(Show body, Show url) => Show (HttpRequest url method body contentTag acceptTag)

Defined in Dormouse.Client.Types

Methods

showsPrec :: Int -> HttpRequest url method body contentTag acceptTag -> ShowS

show :: HttpRequest url method body contentTag acceptTag -> String

showList :: [HttpRequest url method body contentTag acceptTag] -> ShowS

HasHeaders (HttpRequest url method body contentTag acceptTag)

Defined in Dormouse.Client.Types

Methods

getHeaders :: HttpRequest url method body contentTag acceptTag -> Map HeaderName ByteString

getHeaderValue :: HeaderName -> HttpRequest url method body contentTag acceptTag -> Maybe ByteString

data HttpResponse body

Model of an HTTP response with the type parameter body describing the type of the content body.

Constructors

HttpResponse

Fields

• responseStatusCode :: !Int
• responseHeaders :: Map HeaderName ByteString
• responseBody :: body

Instances

Eq body => Eq (HttpResponse body)

Defined in Dormouse.Client.Types

Methods

(==) :: HttpResponse body -> HttpResponse body -> Bool

(/=) :: HttpResponse body -> HttpResponse body -> Bool

Show body => Show (HttpResponse body)

Defined in Dormouse.Client.Types

Methods

showsPrec :: Int -> HttpResponse body -> ShowS

show :: HttpResponse body -> String

showList :: [HttpResponse body] -> ShowS

HasHeaders (HttpResponse b)

Defined in Dormouse.Client.Types

Methods

getHeaders :: HttpResponse b -> Map HeaderName ByteString

getHeaderValue :: HeaderName -> HttpResponse b -> Maybe ByteString

Request building

delete :: IsUrl url => url -> HttpRequest url "DELETE" Empty EmptyPayload acceptTag

Create an HTTP DELETE request with the supplied URI, containing no body and no headers

get :: IsUrl url => url -> HttpRequest url "GET" Empty EmptyPayload acceptTag

Create an HTTP GET request with the supplied URI, containing no body and no headers

head :: IsUrl url => url -> HttpRequest url "HEAD" Empty EmptyPayload acceptTag

Create an HTTP HEAD request with the supplied URI, containing no body and no headers

patch :: IsUrl url => url -> HttpRequest url "PATCH" Empty EmptyPayload acceptTag

Create an HTTP PATCH request with the supplied URI, containing no body and no headers

post :: IsUrl url => url -> HttpRequest url "POST" Empty EmptyPayload acceptTag

Create an HTTP POST request with the supplied URI, containing no body and no headers

put :: IsUrl url => url -> HttpRequest url "PUT" Empty EmptyPayload acceptTag

Create an HTTP PUT request with the supplied URI, containing no body and no headers

supplyBody :: (AllowedBody method b, RequestPayload b contentTag) => Proxy contentTag -> b -> HttpRequest url method b' contentTag' acceptTag -> HttpRequest url method b contentTag acceptTag

Supply a body to an HTTP request using the supplied tag to indicate how the request should be encoded

accept :: HasMediaType acceptTag => Proxy acceptTag -> HttpRequest url method b contentTag acceptTag -> HttpRequest url method b contentTag acceptTag

Apply an accept header derived from the supplied tag proxy and add a type hint to the request, indicating how the response should be decodable

expectAs :: (MonadDormouseClient m, RequestPayload b contentTag, ResponsePayload b' acceptTag, IsUrl url) => Proxy acceptTag -> HttpRequest url method b contentTag acceptTag -> m (HttpResponse b')

Make the supplied HTTP request, expecting an HTTP response in the supplied format with body type b to be delivered in some 'MonadDormouseClient m'

expect :: (MonadDormouseClient m, RequestPayload b contentTag, ResponsePayload b' acceptTag, IsUrl url) => HttpRequest url method b contentTag acceptTag -> m (HttpResponse b')

Make the supplied HTTP request, expecting an HTTP response with body type b to be delivered in some 'MonadDormouseClient m'

Dormouse Client Monad and Transformer

data DormouseClientT m a

The DormouseClientT Monad Transformer

Instances

MonadTrans DormouseClientT

Defined in Dormouse.Client

Methods

lift :: Monad m => m a -> DormouseClientT m a

Monad m => MonadReader DormouseClientConfig (DormouseClientT m)

Defined in Dormouse.Client

Methods

ask :: DormouseClientT m DormouseClientConfig

local :: (DormouseClientConfig -> DormouseClientConfig) -> DormouseClientT m a -> DormouseClientT m a

reader :: (DormouseClientConfig -> a) -> DormouseClientT m a

Monad m => Monad (DormouseClientT m)

Defined in Dormouse.Client

Methods

(>>=) :: DormouseClientT m a -> (a -> DormouseClientT m b) -> DormouseClientT m b

(>>) :: DormouseClientT m a -> DormouseClientT m b -> DormouseClientT m b

return :: a -> DormouseClientT m a

Functor m => Functor (DormouseClientT m)

Defined in Dormouse.Client

Methods

fmap :: (a -> b) -> DormouseClientT m a -> DormouseClientT m b

(<$) :: a -> DormouseClientT m b -> DormouseClientT m a

Applicative m => Applicative (DormouseClientT m)

Defined in Dormouse.Client

Methods

pure :: a -> DormouseClientT m a

(<*>) :: DormouseClientT m (a -> b) -> DormouseClientT m a -> DormouseClientT m b

liftA2 :: (a -> b -> c) -> DormouseClientT m a -> DormouseClientT m b -> DormouseClientT m c

(*>) :: DormouseClientT m a -> DormouseClientT m b -> DormouseClientT m b

(<*) :: DormouseClientT m a -> DormouseClientT m b -> DormouseClientT m a

MonadIO m => MonadIO (DormouseClientT m)

Defined in Dormouse.Client

Methods

liftIO :: IO a -> DormouseClientT m a

MonadThrow m => MonadThrow (DormouseClientT m)

Defined in Dormouse.Client

Methods

throwM :: Exception e => e -> DormouseClientT m a

(MonadIO m, MonadThrow m) => MonadDormouseClient (DormouseClientT m)

Defined in Dormouse.Client

Methods

send :: forall url (method :: Symbol) contentTag acceptTag b. IsUrl url => HttpRequest url method RawRequestPayload contentTag acceptTag -> (HttpResponse (SerialT IO Word8) -> IO (HttpResponse b)) -> DormouseClientT m (HttpResponse b)

type DormouseClient a = DormouseClientT IO a

A simple monad that allows you to run DormouseClient

runDormouseClientT :: DormouseClientConfig -> DormouseClientT m a -> m a

Run a DormouseClientT using the supplied DormouseClientConfig to generate a result in the underlying monad m

runDormouseClient :: DormouseClientConfig -> DormouseClient a -> IO a

Run a DormouseClient using the supplied DormouseClientConfig to generate a result in IO

Dormouse Client Class

class Monad m => MonadDormouseClient m where

MonadDormouseClient describes the capability to send HTTP requests and receive an HTTP response

Methods

send :: IsUrl url => HttpRequest url method RawRequestPayload contentTag acceptTag -> (HttpResponse (SerialT IO Word8) -> IO (HttpResponse b)) -> m (HttpResponse b)

Sends a supplied HTTP request and retrieves a response within the supplied monad m

Instances

(Monad m, MonadIO m, MonadDormouseTestClient m) => MonadDormouseClient m

Defined in Dormouse.Client.Test.Class

Methods

send :: forall url (method :: Symbol) contentTag acceptTag b. IsUrl url => HttpRequest url method RawRequestPayload contentTag acceptTag -> (HttpResponse (SerialT IO Word8) -> IO (HttpResponse b)) -> m (HttpResponse b)

(MonadIO m, MonadThrow m) => MonadDormouseClient (DormouseClientT m)

Defined in Dormouse.Client

Methods

send :: forall url (method :: Symbol) contentTag acceptTag b. IsUrl url => HttpRequest url method RawRequestPayload contentTag acceptTag -> (HttpResponse (SerialT IO Word8) -> IO (HttpResponse b)) -> DormouseClientT m (HttpResponse b)

Dormouse Client Config

newManager :: ManagerSettings -> IO Manager

Create a Manager. The Manager will be shut down automatically via garbage collection.

Creating a new Manager is a relatively expensive operation, you are advised to share a single Manager between requests instead.

The first argument to this function is often defaultManagerSettings, though add-on libraries may provide a recommended replacement.

Since 0.1.0

tlsManagerSettings :: ManagerSettings

Default TLS-enabled manager settings

class HasDormouseClientConfig a where

Describes the capability to retrieve a Dormouse Config

Methods

getDormouseClientConfig :: a -> DormouseClientConfig

Instances

HasDormouseClientConfig DormouseClientConfig

Defined in Dormouse.Client.Class

Methods

getDormouseClientConfig :: DormouseClientConfig -> DormouseClientConfig

newtype DormouseClientConfig

The configuration options required to run Dormouse

Constructors

DormouseClientConfig

Fields

• clientManager :: Manager

Instances

HasDormouseClientConfig DormouseClientConfig

Defined in Dormouse.Client.Class

Methods

getDormouseClientConfig :: DormouseClientConfig -> DormouseClientConfig

Monad m => MonadReader DormouseClientConfig (DormouseClientT m)

Defined in Dormouse.Client

Methods

ask :: DormouseClientT m DormouseClientConfig

local :: (DormouseClientConfig -> DormouseClientConfig) -> DormouseClientT m a -> DormouseClientT m a

reader :: (DormouseClientConfig -> a) -> DormouseClientT m a

Headers

type HeaderName = CI ByteString

The name of an HTTP Header. Header names are case insensitive.

class HasHeaders a where

Describes something which has headers

Methods

getHeaders :: a -> Map HeaderName ByteString

Retrieve all of the headers which a has.

getHeaderValue :: HeaderName -> a -> Maybe ByteString

Try to retrieve a specific header from a with the supplied HeaderName

Instances

HasHeaders (HttpResponse b)

Defined in Dormouse.Client.Types

Methods

getHeaders :: HttpResponse b -> Map HeaderName ByteString

getHeaderValue :: HeaderName -> HttpResponse b -> Maybe ByteString

HasHeaders (HttpRequest url method body contentTag acceptTag)

Defined in Dormouse.Client.Types

Methods

getHeaders :: HttpRequest url method body contentTag acceptTag -> Map HeaderName ByteString

getHeaderValue :: HeaderName -> HttpRequest url method body contentTag acceptTag -> Maybe ByteString

class HasMediaType tag where

Describes an association between a type tag and a specific Media Type

Methods

mediaType :: Proxy tag -> Maybe MediaType

Instances

HasMediaType HtmlPayload

Defined in Dormouse.Client.Payload

Methods

mediaType :: Proxy HtmlPayload -> Maybe MediaType

HasMediaType EmptyPayload

Defined in Dormouse.Client.Payload

Methods

mediaType :: Proxy EmptyPayload -> Maybe MediaType

HasMediaType UrlFormPayload

Defined in Dormouse.Client.Payload

Methods

mediaType :: Proxy UrlFormPayload -> Maybe MediaType

HasMediaType JsonPayload

Defined in Dormouse.Client.Payload

Methods

mediaType :: Proxy JsonPayload -> Maybe MediaType

Methods

data HttpMethod (a :: Symbol) where

Constructors

CONNECT :: HttpMethod "CONNECT"

DELETE :: HttpMethod "DELETE"

HEAD :: HttpMethod "HEAD"

GET :: HttpMethod "GET"

OPTIONS :: HttpMethod "OPTIONS"

PATCH :: HttpMethod "PATCH"

POST :: HttpMethod "POST"

PUT :: HttpMethod "PUT"

TRACE :: HttpMethod "TRACE"

CUSTOM :: KnownSymbol a => Proxy a -> HttpMethod a

Instances

Eq (HttpMethod a)

Defined in Dormouse.Client.Methods

Methods

(==) :: HttpMethod a -> HttpMethod a -> Bool

(/=) :: HttpMethod a -> HttpMethod a -> Bool

Show (HttpMethod a)

Defined in Dormouse.Client.Methods

Methods

showsPrec :: Int -> HttpMethod a -> ShowS

show :: HttpMethod a -> String

showList :: [HttpMethod a] -> ShowS

type family AllowedBody (a :: Symbol) b :: Constraint

Instances

type AllowedBody "CONNECT" b

Defined in Dormouse.Client.Methods

type AllowedBody "CONNECT" b = b ~ Empty

type AllowedBody "DELETE" b

Defined in Dormouse.Client.Methods

type AllowedBody "DELETE" b = ()

type AllowedBody "GET" b

Defined in Dormouse.Client.Methods

type AllowedBody "GET" b = b ~ Empty

type AllowedBody "HEAD" b

Defined in Dormouse.Client.Methods

type AllowedBody "HEAD" b = b ~ Empty

type AllowedBody "OPTIONS" b

Defined in Dormouse.Client.Methods

type AllowedBody "OPTIONS" b = b ~ Empty

type AllowedBody "PATCH" b

Defined in Dormouse.Client.Methods

type AllowedBody "PATCH" b = ()

type AllowedBody "POST" b

Defined in Dormouse.Client.Methods

type AllowedBody "POST" b = ()

type AllowedBody "PUT" b

Defined in Dormouse.Client.Methods

type AllowedBody "PUT" b = ()

type AllowedBody "TRACE" b

Defined in Dormouse.Client.Methods

type AllowedBody "TRACE" b = b ~ Empty

methodAsByteString :: HttpMethod a -> ByteString

Payloads

data RawRequestPayload

A raw HTTP Request payload consisting of a stream of bytes with either a defined Content Length or using Chunked Transfer Encoding

Constructors

DefinedContentLength Word64 (SerialT IO Word8)

DefinedContentLength represents a payload where the size of the message is known in advance and the content length header can be computed

ChunkedTransfer (SerialT IO Word8)

ChunkedTransfer represents a payload with indertiminate length, to be sent using chunked transfer encoding

class HasMediaType contentTag => RequestPayload body contentTag where

RequestPayload relates a type of content and a payload tag used to describe that type to its byte stream representation and the constraints required to encode it

Methods

serialiseRequest :: Proxy contentTag -> HttpRequest url method body contentTag acceptTag -> HttpRequest url method RawRequestPayload contentTag acceptTag

Generates a the byte stream representation from the supplied content

Instances

ToForm body => RequestPayload body UrlFormPayload

Defined in Dormouse.Client.Payload

Methods

serialiseRequest :: forall url (method :: Symbol) acceptTag. Proxy UrlFormPayload -> HttpRequest url method body UrlFormPayload acceptTag -> HttpRequest url method RawRequestPayload UrlFormPayload acceptTag

ToJSON body => RequestPayload body JsonPayload

Defined in Dormouse.Client.Payload

Methods

serialiseRequest :: forall url (method :: Symbol) acceptTag. Proxy JsonPayload -> HttpRequest url method body JsonPayload acceptTag -> HttpRequest url method RawRequestPayload JsonPayload acceptTag

RequestPayload Text HtmlPayload

Defined in Dormouse.Client.Payload

Methods

serialiseRequest :: forall url (method :: Symbol) acceptTag. Proxy HtmlPayload -> HttpRequest url method Text HtmlPayload acceptTag -> HttpRequest url method RawRequestPayload HtmlPayload acceptTag

RequestPayload Empty EmptyPayload

Defined in Dormouse.Client.Payload

Methods

serialiseRequest :: forall url (method :: Symbol) acceptTag. Proxy EmptyPayload -> HttpRequest url method Empty EmptyPayload acceptTag -> HttpRequest url method RawRequestPayload EmptyPayload acceptTag

class HasMediaType tag => ResponsePayload body tag where

ResponsePayload relates a type of content and a payload tag used to describe that type to its byte stream representation and the constraints required to decode it

Methods

deserialiseRequest :: Proxy tag -> HttpResponse (SerialT IO Word8) -> IO (HttpResponse body)

Decodes the high level representation from the supplied byte stream

Instances

FromForm body => ResponsePayload body UrlFormPayload

Defined in Dormouse.Client.Payload

Methods

deserialiseRequest :: Proxy UrlFormPayload -> HttpResponse (SerialT IO Word8) -> IO (HttpResponse body)

FromJSON body => ResponsePayload body JsonPayload

Defined in Dormouse.Client.Payload

Methods

deserialiseRequest :: Proxy JsonPayload -> HttpResponse (SerialT IO Word8) -> IO (HttpResponse body)

ResponsePayload Text HtmlPayload

Defined in Dormouse.Client.Payload

Methods

deserialiseRequest :: Proxy HtmlPayload -> HttpResponse (SerialT IO Word8) -> IO (HttpResponse Text)

ResponsePayload Empty EmptyPayload

Defined in Dormouse.Client.Payload

Methods

deserialiseRequest :: Proxy EmptyPayload -> HttpResponse (SerialT IO Word8) -> IO (HttpResponse Empty)

data EmptyPayload

Instances

HasMediaType EmptyPayload

Defined in Dormouse.Client.Payload

Methods

mediaType :: Proxy EmptyPayload -> Maybe MediaType

ResponsePayload Empty EmptyPayload

Defined in Dormouse.Client.Payload

Methods

deserialiseRequest :: Proxy EmptyPayload -> HttpResponse (SerialT IO Word8) -> IO (HttpResponse Empty)

RequestPayload Empty EmptyPayload

Defined in Dormouse.Client.Payload

Methods

serialiseRequest :: forall url (method :: Symbol) acceptTag. Proxy EmptyPayload -> HttpRequest url method Empty EmptyPayload acceptTag -> HttpRequest url method RawRequestPayload EmptyPayload acceptTag

data HtmlPayload

Instances

HasMediaType HtmlPayload

Defined in Dormouse.Client.Payload

Methods

mediaType :: Proxy HtmlPayload -> Maybe MediaType

ResponsePayload Text HtmlPayload

Defined in Dormouse.Client.Payload

Methods

deserialiseRequest :: Proxy HtmlPayload -> HttpResponse (SerialT IO Word8) -> IO (HttpResponse Text)

RequestPayload Text HtmlPayload

Defined in Dormouse.Client.Payload

Methods

serialiseRequest :: forall url (method :: Symbol) acceptTag. Proxy HtmlPayload -> HttpRequest url method Text HtmlPayload acceptTag -> HttpRequest url method RawRequestPayload HtmlPayload acceptTag

data JsonPayload

Instances

HasMediaType JsonPayload

Defined in Dormouse.Client.Payload

Methods

mediaType :: Proxy JsonPayload -> Maybe MediaType

FromJSON body => ResponsePayload body JsonPayload

Defined in Dormouse.Client.Payload

Methods

deserialiseRequest :: Proxy JsonPayload -> HttpResponse (SerialT IO Word8) -> IO (HttpResponse body)

ToJSON body => RequestPayload body JsonPayload

Defined in Dormouse.Client.Payload

Methods

serialiseRequest :: forall url (method :: Symbol) acceptTag. Proxy JsonPayload -> HttpRequest url method body JsonPayload acceptTag -> HttpRequest url method RawRequestPayload JsonPayload acceptTag

data UrlFormPayload

Instances

HasMediaType UrlFormPayload

Defined in Dormouse.Client.Payload

Methods

mediaType :: Proxy UrlFormPayload -> Maybe MediaType

FromForm body => ResponsePayload body UrlFormPayload

Defined in Dormouse.Client.Payload

Methods

deserialiseRequest :: Proxy UrlFormPayload -> HttpResponse (SerialT IO Word8) -> IO (HttpResponse body)

ToForm body => RequestPayload body UrlFormPayload

Defined in Dormouse.Client.Payload

Methods

serialiseRequest :: forall url (method :: Symbol) acceptTag. Proxy UrlFormPayload -> HttpRequest url method body UrlFormPayload acceptTag -> HttpRequest url method RawRequestPayload UrlFormPayload acceptTag

data Empty

Instances

ResponsePayload Empty EmptyPayload

Defined in Dormouse.Client.Payload

Methods

deserialiseRequest :: Proxy EmptyPayload -> HttpResponse (SerialT IO Word8) -> IO (HttpResponse Empty)

RequestPayload Empty EmptyPayload

Defined in Dormouse.Client.Payload

Methods

serialiseRequest :: forall url (method :: Symbol) acceptTag. Proxy EmptyPayload -> HttpRequest url method Empty EmptyPayload acceptTag -> HttpRequest url method RawRequestPayload EmptyPayload acceptTag

json :: Proxy JsonPayload

A type tag used to indicate that a request/response should be encoded/decoded as application/json data

urlForm :: Proxy UrlFormPayload

A type tag used to indicate that a request/response should be encoded/decoded as application/x-www-form-urlencoded data

noPayload :: Proxy EmptyPayload

A type tag used to indicate that a request/response has no payload

html :: Proxy HtmlPayload

A type tag used to indicate that a request/response should be encoded/decoded as text/html data

Exceptions

data SomeDormouseException

Constructors

forall e.Exception e => SomeDormouseException e

Instances

Show SomeDormouseException

Defined in Dormouse.Client.Exception

Methods

showsPrec :: Int -> SomeDormouseException -> ShowS

show :: SomeDormouseException -> String

showList :: [SomeDormouseException] -> ShowS

Exception SomeDormouseException

Defined in Dormouse.Client.Exception

Methods

toException :: SomeDormouseException -> SomeException

fromException :: SomeException -> Maybe SomeDormouseException

displayException :: SomeDormouseException -> String

newtype DecodingException

DecodingException is used to when something has gone wrong decoding an http response into the expected representation, e.g. json was expected but the response json was invalid.

Constructors

DecodingException

Fields

• decodingExceptionMessage :: Text

Instances

Show DecodingException

Defined in Dormouse.Client.Exception

Methods

showsPrec :: Int -> DecodingException -> ShowS

show :: DecodingException -> String

showList :: [DecodingException] -> ShowS

Exception DecodingException

Defined in Dormouse.Client.Exception

Methods

toException :: DecodingException -> SomeException

fromException :: SomeException -> Maybe DecodingException

displayException :: DecodingException -> String

newtype MediaTypeException

MediaTypeException is used to indicate an error parsing a MediaType header such as "Content-Type" into a valid MediaType

Constructors

MediaTypeException

Fields

• mediaTypeExceptionMessage :: Text

Instances

Show MediaTypeException

Defined in Dormouse.Client.Exception

Methods

showsPrec :: Int -> MediaTypeException -> ShowS

show :: MediaTypeException -> String

showList :: [MediaTypeException] -> ShowS

Exception MediaTypeException

Defined in Dormouse.Client.Exception

Methods

toException :: MediaTypeException -> SomeException

fromException :: SomeException -> Maybe MediaTypeException

displayException :: MediaTypeException -> String

newtype UnexpectedStatusCodeException

UnexpectedStatusCodeException is used to indicate that the remote server returned an unexpected status code value, for instance an unsuccessful (non-2XX) status code.

Constructors

UnexpectedStatusCodeException

Fields

• uscStatusCode :: Int

Instances

Show UnexpectedStatusCodeException

Defined in Dormouse.Client.Exception

Methods

showsPrec :: Int -> UnexpectedStatusCodeException -> ShowS

show :: UnexpectedStatusCodeException -> String

showList :: [UnexpectedStatusCodeException] -> ShowS

Exception UnexpectedStatusCodeException

Defined in Dormouse.Client.Exception

Methods

toException :: UnexpectedStatusCodeException -> SomeException

fromException :: SomeException -> Maybe UnexpectedStatusCodeException

displayException :: UnexpectedStatusCodeException -> String

newtype UriException

UriException is used to indicate an error parsing a URI

Constructors

UriException

Fields

• uriExceptionMessage :: Text

Instances

Show UriException

Defined in Dormouse.Uri.Exception

Methods

showsPrec :: Int -> UriException -> ShowS

show :: UriException -> String

showList :: [UriException] -> ShowS

Exception UriException

Defined in Dormouse.Uri.Exception

Methods

toException :: UriException -> SomeException

fromException :: SomeException -> Maybe UriException

displayException :: UriException -> String

newtype UrlException

UrlException is used to indicate an error in transforming a valid URI into a URL, e.g. the URI refers to a different schema such as file

Constructors

UrlException

Fields

• urlExceptionMessage :: Text

Instances

Show UrlException

Defined in Dormouse.Url.Exception

Methods

showsPrec :: Int -> UrlException -> ShowS

show :: UrlException -> String

showList :: [UrlException] -> ShowS

Exception UrlException

Defined in Dormouse.Url.Exception

Methods

toException :: UrlException -> SomeException

fromException :: SomeException -> Maybe UrlException

displayException :: UrlException -> String

Uri

data Uri

A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource. It is defined according to RFC 3986 (https://tools.ietf.org/html/rfc3986). URIs can be absolute (i.e. defined against a specific scheme) or relative.

Instances

Eq Uri

Defined in Dormouse.Uri.Types

Methods

(==) :: Uri -> Uri -> Bool

(/=) :: Uri -> Uri -> Bool

Show Uri

Defined in Dormouse.Uri.Types

Methods

showsPrec :: Int -> Uri -> ShowS

show :: Uri -> String

showList :: [Uri] -> ShowS

Lift Uri

Defined in Dormouse.Uri.Types

Methods

lift :: Uri -> Q Exp

liftTyped :: Uri -> Q (TExp Uri)

parseUri :: MonadThrow m => ByteString -> m Uri

Parse an ascii ByteString as an absolute uri, throwing a UriException in m if this fails

Url

data Url (scheme :: Symbol)

A Url is defined here as an absolute URI in the http or https schemes. Authority components are requried by the http / https Uri schemes.

Instances

Lift (Url scheme :: Type)

Defined in Dormouse.Url.Types

Methods

lift :: Url scheme -> Q Exp

liftTyped :: Url scheme -> Q (TExp (Url scheme))

Eq (Url scheme)

Defined in Dormouse.Url.Types

Methods

(==) :: Url scheme -> Url scheme -> Bool

(/=) :: Url scheme -> Url scheme -> Bool

Show (Url scheme)

Defined in Dormouse.Url.Types

Methods

showsPrec :: Int -> Url scheme -> ShowS

show :: Url scheme -> String

showList :: [Url scheme] -> ShowS

IsUrl (Url scheme)

Defined in Dormouse.Url.Class

Methods

asAnyUrl :: Url scheme -> AnyUrl

data AnyUrl

AnyUrl is a wrapper aroud Url which allows either http or https urls.

Constructors

AnyUrl (Url scheme)

Instances

Eq AnyUrl

Defined in Dormouse.Url.Types

Methods

(==) :: AnyUrl -> AnyUrl -> Bool

(/=) :: AnyUrl -> AnyUrl -> Bool

Show AnyUrl

Defined in Dormouse.Url.Types

Methods

showsPrec :: Int -> AnyUrl -> ShowS

show :: AnyUrl -> String

showList :: [AnyUrl] -> ShowS

IsUrl AnyUrl

Defined in Dormouse.Url.Class

Methods

asAnyUrl :: AnyUrl -> AnyUrl

Lift AnyUrl

Defined in Dormouse.Url.Types

Methods

lift :: AnyUrl -> Q Exp

liftTyped :: AnyUrl -> Q (TExp AnyUrl)

class (Eq url, Show url) => IsUrl url where

Methods

asAnyUrl :: url -> AnyUrl

Instances

IsUrl AnyUrl

Defined in Dormouse.Url.Class

Methods

asAnyUrl :: AnyUrl -> AnyUrl

IsUrl (Url scheme)

Defined in Dormouse.Url.Class

Methods

asAnyUrl :: Url scheme -> AnyUrl

ensureHttp :: MonadThrow m => AnyUrl -> m (Url "http")

Ensure that the supplied Url uses the _http_ scheme, throwing a UrlException in m if this is not the case

ensureHttps :: MonadThrow m => AnyUrl -> m (Url "https")

Ensure that the supplied Url uses the _https_ scheme, throwing a UrlException in m if this is not the case

parseUrl :: MonadThrow m => ByteString -> m AnyUrl

Parse an ascii ByteString as a url, throwing a UriException in m if this fails

parseHttpUrl :: MonadThrow m => ByteString -> m (Url "http")

Parse an ascii ByteString as an http url, throwing a UriException in m if this fails

parseHttpsUrl :: MonadThrow m => ByteString -> m (Url "https")

Parse an ascii ByteString as an https url, throwing a UriException in m if this fails