Dormouse.Url

Documentation

data UrlComponents

Constructors

UrlComponents

Fields

• urlAuthority :: Authority
• urlPath :: Path 'Absolute
• urlQuery :: Maybe Query
• urlFragment :: Maybe Fragment

Instances

Eq UrlComponents

Defined in Dormouse.Url.Types

Methods

(==) :: UrlComponents -> UrlComponents -> Bool

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

Show UrlComponents

Defined in Dormouse.Url.Types

Methods

showsPrec :: Int -> UrlComponents -> ShowS

show :: UrlComponents -> String

showList :: [UrlComponents] -> ShowS

Lift UrlComponents

Defined in Dormouse.Url.Types

Methods

lift :: UrlComponents -> Q Exp

liftTyped :: UrlComponents -> Q (TExp UrlComponents)

data UrlScheme

Constructors

HttpScheme

HttpsScheme

data Url (scheme :: Symbol) where

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.

Constructors

HttpUrl :: UrlComponents -> Url "http"

HttpsUrl :: UrlComponents -> Url "https"

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

forall scheme. 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)

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

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