Data.Url

This library helps us distinguish how we present URLs - we might show them relatively, absolutely (with the URI authority - scheme, port, hostname, etc.), or grounded - where the path begins with /.

We leverage Chris Done's path library to distinguish relative vs. grounded paths at compile time, and provide some additional features like a file extension and query parameters in path-extra.

Classes

class MonadUrl base type' m where

Turns a Path or Location into a String, where the rendering behavior (relative, grounded and absolute) is encoded in the monad you use, much like LoggingT and NoLoggingT from monad-logger.

Methods

pathUrl :: Path base type' -> m String

locUrl :: Location base type' -> m String

Instances

MonadUrl b t IO

(MonadUrl b t m, Monad m) => MonadUrl b t (NoLoggingT m)

(MonadUrl b t m, Monad m) => MonadUrl b t (LoggingT m)

(MonadUrl b t m, Monad m) => MonadUrl b t (IdentityT m)

(MonadUrl b t m, Monad m) => MonadUrl b t (ResourceT m)

(MonadUrl b t m, Monad m) => MonadUrl b t (ListT m)

(MonadUrl b t m, Monad m) => MonadUrl b t (MaybeT m)

Applicative m => MonadUrl Rel File (RelativeUrlT m)

Applicative m => MonadUrl Rel Dir (RelativeUrlT m)

Applicative m => MonadUrl Abs File (AbsoluteUrlT m)

Applicative m => MonadUrl Abs File (GroundedUrlT m)

Applicative m => MonadUrl Abs Dir (AbsoluteUrlT m)

Applicative m => MonadUrl Abs Dir (GroundedUrlT m)

(MonadUrl b t m, Monad m) => MonadUrl b t (ExceptT e m)

(MonadUrl b t m, Monad m) => MonadUrl b t (ContT r m)

(MonadUrl b t m, Monad m, Error e) => MonadUrl b t (ErrorT e m)

(MonadUrl b t m, Monad m) => MonadUrl b t (StateT s m)

(MonadUrl b t m, Monad m, Monoid w) => MonadUrl b t (WriterT w m)

(MonadUrl b t m, Monad m) => MonadUrl b t (ReaderT r m)

(MonadUrl b t m, Monad m, Monoid w) => MonadUrl b t (RWST r w s m)

class ToLocation sym base type' | sym -> base type' where

Convenience typeclass for symbolic, stringless routes - make an instance for your own data type to use your constructors as route-referencing symbols.

Methods

toLocation :: MonadThrow m => sym -> m (Location base type')

Types

data UrlAuthority

The hostname of a URL.

Constructors

UrlAuthority

Fields

urlScheme :: String

urlSlashes :: Bool

urlAuth :: Maybe UrlAuthent

urlHost :: String

urlPort :: Maybe Int

Instances

Eq UrlAuthority

Ord UrlAuthority

Show UrlAuthority

showUrlAuthority :: UrlAuthority -> String

data UrlAuthent

Constructors

UrlAuthent

Fields

urlAuthUser :: String

urlAuthPass :: Maybe String

Instances

Eq UrlAuthent

Ord UrlAuthent

Show UrlAuthent

showUrlAuthent :: UrlAuthent -> String

Relative Urls

newtype RelativeUrlT m a

Constructors

RelativeUrlT

Fields

runRelativeUrlT :: m a

Instances

MonadTrans RelativeUrlT

MonadTransControl RelativeUrlT

MMonad RelativeUrlT

MFunctor RelativeUrlT

MonadRWS r w s m => MonadRWS r w s (RelativeUrlT m)

Applicative m => MonadUrl Rel File (RelativeUrlT m)

Applicative m => MonadUrl Rel Dir (RelativeUrlT m)

MonadBase b m => MonadBase b (RelativeUrlT m)

MonadError e m => MonadError e (RelativeUrlT m)

MonadBaseControl b m => MonadBaseControl b (RelativeUrlT m)

MonadReader r m => MonadReader r (RelativeUrlT m)

MonadWriter w m => MonadWriter w (RelativeUrlT m)

MonadState s m => MonadState s (RelativeUrlT m)

Monad m => Monad (RelativeUrlT m)

Functor m => Functor (RelativeUrlT m)

MonadFix m => MonadFix (RelativeUrlT m)

Applicative m => Applicative (RelativeUrlT m)

Alternative m => Alternative (RelativeUrlT m)

MonadPlus m => MonadPlus (RelativeUrlT m)

MonadIO m => MonadIO (RelativeUrlT m)

MonadThrow m => MonadThrow (RelativeUrlT m)

MonadMask m => MonadMask (RelativeUrlT m)

MonadCatch m => MonadCatch (RelativeUrlT m)

MonadCont m => MonadCont (RelativeUrlT m)

(MonadResource m, MonadBase IO m) => MonadResource (RelativeUrlT m)

MonadLogger m => MonadLogger (RelativeUrlT m)

Eq (m a) => Eq (RelativeUrlT m a)

Ord (m a) => Ord (RelativeUrlT m a)

Show (m a) => Show (RelativeUrlT m a)

type StT RelativeUrlT a = a

type StM (RelativeUrlT m) a = ComposeSt RelativeUrlT m a

type RelativeUrl = RelativeUrlT Identity

Grounded Urls

newtype GroundedUrlT m a

Constructors

GroundedUrlT

Fields

runGroundedUrlT :: m a

Instances

MonadTrans GroundedUrlT

MonadTransControl GroundedUrlT

MMonad GroundedUrlT

MFunctor GroundedUrlT

MonadRWS r w s m => MonadRWS r w s (GroundedUrlT m)

Applicative m => MonadUrl Abs File (GroundedUrlT m)

Applicative m => MonadUrl Abs Dir (GroundedUrlT m)

MonadBase b m => MonadBase b (GroundedUrlT m)

MonadError e m => MonadError e (GroundedUrlT m)

MonadBaseControl b m => MonadBaseControl b (GroundedUrlT m)

MonadReader r m => MonadReader r (GroundedUrlT m)

MonadWriter w m => MonadWriter w (GroundedUrlT m)

MonadState s m => MonadState s (GroundedUrlT m)

Monad m => Monad (GroundedUrlT m)

Functor m => Functor (GroundedUrlT m)

MonadFix m => MonadFix (GroundedUrlT m)

Applicative m => Applicative (GroundedUrlT m)

Alternative m => Alternative (GroundedUrlT m)

MonadPlus m => MonadPlus (GroundedUrlT m)

MonadIO m => MonadIO (GroundedUrlT m)

MonadThrow m => MonadThrow (GroundedUrlT m)

MonadMask m => MonadMask (GroundedUrlT m)

MonadCatch m => MonadCatch (GroundedUrlT m)

MonadCont m => MonadCont (GroundedUrlT m)

(MonadResource m, MonadBase IO m) => MonadResource (GroundedUrlT m)

MonadLogger m => MonadLogger (GroundedUrlT m)

Eq (m a) => Eq (GroundedUrlT m a)

Ord (m a) => Ord (GroundedUrlT m a)

Show (m a) => Show (GroundedUrlT m a)

type StT GroundedUrlT a = a

type StM (GroundedUrlT m) a = ComposeSt GroundedUrlT m a

type GroundedUrl = GroundedUrlT Identity

Absolute Urls

newtype AbsoluteUrlT m a

Constructors

AbsoluteUrlT

Fields

runAbsoluteUrlT :: UrlAuthority -> m a

Instances

MonadTrans AbsoluteUrlT

MonadTransControl AbsoluteUrlT

MMonad AbsoluteUrlT

MFunctor AbsoluteUrlT

MonadRWS r w s m => MonadRWS r w s (AbsoluteUrlT m)

Applicative m => MonadUrl Abs File (AbsoluteUrlT m)

Applicative m => MonadUrl Abs Dir (AbsoluteUrlT m)

MonadBase b m => MonadBase b (AbsoluteUrlT m)

MonadError e m => MonadError e (AbsoluteUrlT m)

MonadBaseControl b m => MonadBaseControl b (AbsoluteUrlT m)

MonadReader r m => MonadReader r (AbsoluteUrlT m)

MonadWriter w m => MonadWriter w (AbsoluteUrlT m)

MonadState s m => MonadState s (AbsoluteUrlT m)

Monad m => Monad (AbsoluteUrlT m)

Functor m => Functor (AbsoluteUrlT m)

Applicative m => Applicative (AbsoluteUrlT m)

MonadIO m => MonadIO (AbsoluteUrlT m)

MonadThrow m => MonadThrow (AbsoluteUrlT m)

MonadMask m => MonadMask (AbsoluteUrlT m)

MonadCatch m => MonadCatch (AbsoluteUrlT m)

MonadCont m => MonadCont (AbsoluteUrlT m)

MonadResource m => MonadResource (AbsoluteUrlT m)

MonadLogger m => MonadLogger (AbsoluteUrlT m)

type StT AbsoluteUrlT a = a

type StM (AbsoluteUrlT m) a = ComposeSt AbsoluteUrlT m a

type AbsoluteUrl = AbsoluteUrlT Identity