Copyright	(c) Athan L. Clark
License	MIT
Maintainer	Athan L. Clark <[email protected]>
Stability	experimental
Portability	GHC
Safe Haskell	None
Language	Haskell2010

Data.Url

Contents

Classes
Types

Description

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.

Synopsis

class MonadUrl base (m :: Type -> Type) | m -> base where
- locToUrl :: Location base -> m URL
data URL
- = AbsURL URI
- | RelURL (Location Rel)
printURL :: URL -> Text
newtype RelativeUrlT (m :: Type -> Type) a = RelativeUrlT {
- runRelativeUrlT :: m a
}
type RelativeUrl = RelativeUrlT Identity
newtype GroundedUrlT (m :: Type -> Type) a = GroundedUrlT {
- runGroundedUrlT :: m a
}
type GroundedUrl = GroundedUrlT Identity
newtype AbsoluteUrlT (m :: Type -> Type) a = AbsoluteUrlT {
- runAbsoluteUrlT :: (Location Abs -> URI) -> m a
}
type AbsoluteUrl = AbsoluteUrlT Identity
mkUriLocEmpty :: Location Abs -> URI
getPathChunks :: Path base type' -> Vector Text
packLocation :: Maybe Text -> Bool -> URIAuth -> Location Abs -> URI
unpackLocation :: URI -> (Maybe Text, Bool, URIAuth, Location Abs)

Classes

class MonadUrl base (m :: Type -> Type) | m -> base where Source #

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

locToUrl :: Location base -> m URL Source #

Create a URL from a Location - either a directory or file, and can include query strings & fragments.

Instances

Instances details

MonadUrl Rel IO Source #	Treated as relative urls
Instance details Defined in Data.Url Methods locToUrl :: Location Rel -> IO URL Source #
Applicative m => MonadUrl Abs (AbsoluteUrlT m) Source #
Instance details Defined in Data.Url Methods locToUrl :: Location Abs -> AbsoluteUrlT m URL Source #
Applicative m => MonadUrl Abs (GroundedUrlT m) Source #
Instance details Defined in Data.Url Methods locToUrl :: Location Abs -> GroundedUrlT m URL Source #
Applicative m => MonadUrl Rel (RelativeUrlT m) Source #
Instance details Defined in Data.Url Methods locToUrl :: Location Rel -> RelativeUrlT m URL Source #
(MonadUrl base m, Monad m) => MonadUrl base (LoggingT m) Source #
Instance details Defined in Data.Url Methods locToUrl :: Location base -> LoggingT m URL Source #
(MonadUrl base m, Monad m) => MonadUrl base (NoLoggingT m) Source #
Instance details Defined in Data.Url Methods locToUrl :: Location base -> NoLoggingT m URL Source #
(MonadUrl base m, Monad m) => MonadUrl base (ResourceT m) Source #
Instance details Defined in Data.Url Methods locToUrl :: Location base -> ResourceT m URL Source #
(MonadUrl base m, Monad m) => MonadUrl base (MaybeT m) Source #
Instance details Defined in Data.Url Methods locToUrl :: Location base -> MaybeT m URL Source #
(MonadUrl base m, Monad m) => MonadUrl base (ExceptT e m) Source #
Instance details Defined in Data.Url Methods locToUrl :: Location base -> ExceptT e m URL Source #
(MonadUrl base m, Monad m) => MonadUrl base (IdentityT m) Source #
Instance details Defined in Data.Url Methods locToUrl :: Location base -> IdentityT m URL Source #
(MonadUrl base m, Monad m) => MonadUrl base (ReaderT r m) Source #
Instance details Defined in Data.Url Methods locToUrl :: Location base -> ReaderT r m URL Source #
(MonadUrl base m, Monad m) => MonadUrl base (StateT s m) Source #
Instance details Defined in Data.Url Methods locToUrl :: Location base -> StateT s m URL Source #
(MonadUrl base m, Monad m, Monoid w) => MonadUrl base (WriterT w m) Source #
Instance details Defined in Data.Url Methods locToUrl :: Location base -> WriterT w m URL Source #
(MonadUrl base m, Monad m) => MonadUrl base (ContT r m) Source #
Instance details Defined in Data.Url Methods locToUrl :: Location base -> ContT r m URL Source #
(MonadUrl base m, Monad m, Monoid w) => MonadUrl base (RWST r w s m) Source #
Instance details Defined in Data.Url Methods locToUrl :: Location base -> RWST r w s m URL Source #

Types

URL

data URL Source #

Either a URI (which could include a hostname), or a relative url.

Constructors

AbsURL URI
RelURL (Location Rel)

printURL :: URL -> Text Source #

Relative Urls

newtype RelativeUrlT (m :: Type -> Type) a Source #

When printing a URL generated by a Location in this context, they will always omit the hostname information and print path references relatively (without ./).

Constructors

RelativeUrlT
Fields runRelativeUrlT :: m a

Instances

Instances details

MMonad RelativeUrlT Source #

Instance details

Defined in Data.Url

Methods

embed :: forall (n :: Type -> Type) m b. Monad n => (forall a. m a -> RelativeUrlT n a) -> RelativeUrlT m b -> RelativeUrlT n b #

MonadTransControl RelativeUrlT Source #

Instance details

Defined in Data.Url

Associated Types

type StT RelativeUrlT a
Instance details Defined in Data.Url type StT RelativeUrlT a = a

Methods

liftWith :: Monad m => (Run RelativeUrlT -> m a) -> RelativeUrlT m a #

restoreT :: Monad m => m (StT RelativeUrlT a) -> RelativeUrlT m a #

MonadTrans RelativeUrlT Source #

Instance details

Defined in Data.Url

Methods

lift :: Monad m => m a -> RelativeUrlT m a #

MFunctor RelativeUrlT Source #

Instance details

Defined in Data.Url

Methods

hoist :: Monad m => (forall a. m a -> n a) -> RelativeUrlT m b -> RelativeUrlT n b #

MonadTransControl RelativeUrlT Identity Source #

Instance details

Defined in Data.Url

Methods

liftWith :: Monad m => (Run RelativeUrlT Identity -> m a) -> RelativeUrlT m a #

restoreT :: Monad m => m (Identity a) -> RelativeUrlT m a #

(MonadReader r m, MonadWriter w m, MonadState s m) => MonadRWS r w s (RelativeUrlT m) Source #

Instance details

Defined in Data.Url

MonadBaseControl b m => MonadBaseControl b (RelativeUrlT m) Source #

Instance details

Defined in Data.Url

Methods

liftBaseWith :: (RunInBase (RelativeUrlT m) b -> b a) -> RelativeUrlT m a #

restoreM :: StM (RelativeUrlT m) a -> RelativeUrlT m a #

MonadError e m => MonadError e (RelativeUrlT m) Source #

Instance details

Defined in Data.Url

Methods

throwError :: e -> RelativeUrlT m a #

catchError :: RelativeUrlT m a -> (e -> RelativeUrlT m a) -> RelativeUrlT m a #

MonadReader r m => MonadReader r (RelativeUrlT m) Source #

Instance details

Defined in Data.Url

Methods

ask :: RelativeUrlT m r #

local :: (r -> r) -> RelativeUrlT m a -> RelativeUrlT m a #

reader :: (r -> a) -> RelativeUrlT m a #

MonadState s m => MonadState s (RelativeUrlT m) Source #

Instance details

Defined in Data.Url

Methods

get :: RelativeUrlT m s #

put :: s -> RelativeUrlT m () #

state :: (s -> (a, s)) -> RelativeUrlT m a #

MonadWriter w m => MonadWriter w (RelativeUrlT m) Source #

Instance details

Defined in Data.Url

Methods

writer :: (a, w) -> RelativeUrlT m a #

tell :: w -> RelativeUrlT m () #

listen :: RelativeUrlT m a -> RelativeUrlT m (a, w) #

pass :: RelativeUrlT m (a, w -> w) -> RelativeUrlT m a #

MonadBase b m => MonadBase b (RelativeUrlT m) Source #

Instance details

Defined in Data.Url

Methods

liftBase :: b α -> RelativeUrlT m α #

Applicative m => MonadUrl Rel (RelativeUrlT m) Source #

Instance details

Defined in Data.Url

Methods

locToUrl :: Location Rel -> RelativeUrlT m URL Source #

MonadBaseControl b m stM => MonadBaseControl b (RelativeUrlT m) (Compose stM Identity) Source #

Instance details

Defined in Data.Url

Methods

liftBaseWith :: (RunInBase (RelativeUrlT m) b (Compose stM Identity) -> b a) -> RelativeUrlT m a #

restoreM :: Compose stM Identity a -> RelativeUrlT m a #

MonadFix m => MonadFix (RelativeUrlT m) Source #

Instance details

Defined in Data.Url

Methods

mfix :: (a -> RelativeUrlT m a) -> RelativeUrlT m a #

MonadIO m => MonadIO (RelativeUrlT m) Source #

Instance details

Defined in Data.Url

Methods

liftIO :: IO a -> RelativeUrlT m a #

Alternative m => Alternative (RelativeUrlT m) Source #

Instance details

Defined in Data.Url

Methods

empty :: RelativeUrlT m a #

(<|>) :: RelativeUrlT m a -> RelativeUrlT m a -> RelativeUrlT m a #

some :: RelativeUrlT m a -> RelativeUrlT m [a] #

many :: RelativeUrlT m a -> RelativeUrlT m [a] #

Applicative m => Applicative (RelativeUrlT m) Source #

Instance details

Defined in Data.Url

Methods

pure :: a -> RelativeUrlT m a #

(<*>) :: RelativeUrlT m (a -> b) -> RelativeUrlT m a -> RelativeUrlT m b #

liftA2 :: (a -> b -> c) -> RelativeUrlT m a -> RelativeUrlT m b -> RelativeUrlT m c #

(*>) :: RelativeUrlT m a -> RelativeUrlT m b -> RelativeUrlT m b #

(<*) :: RelativeUrlT m a -> RelativeUrlT m b -> RelativeUrlT m a #

Functor m => Functor (RelativeUrlT m) Source #

Instance details

Defined in Data.Url

Methods

fmap :: (a -> b) -> RelativeUrlT m a -> RelativeUrlT m b #

(<$) :: a -> RelativeUrlT m b -> RelativeUrlT m a #

Monad m => Monad (RelativeUrlT m) Source #

Instance details

Defined in Data.Url

Methods

(>>=) :: RelativeUrlT m a -> (a -> RelativeUrlT m b) -> RelativeUrlT m b #

(>>) :: RelativeUrlT m a -> RelativeUrlT m b -> RelativeUrlT m b #

return :: a -> RelativeUrlT m a #

MonadPlus m => MonadPlus (RelativeUrlT m) Source #

Instance details

Defined in Data.Url

Methods

mzero :: RelativeUrlT m a #

mplus :: RelativeUrlT m a -> RelativeUrlT m a -> RelativeUrlT m a #

MonadCatch m => MonadCatch (RelativeUrlT m) Source #

Instance details

Defined in Data.Url

Methods

catch :: (HasCallStack, Exception e) => RelativeUrlT m a -> (e -> RelativeUrlT m a) -> RelativeUrlT m a #

MonadMask m => MonadMask (RelativeUrlT m) Source #

Instance details

Defined in Data.Url

Methods

mask :: HasCallStack => ((forall a. RelativeUrlT m a -> RelativeUrlT m a) -> RelativeUrlT m b) -> RelativeUrlT m b #

uninterruptibleMask :: HasCallStack => ((forall a. RelativeUrlT m a -> RelativeUrlT m a) -> RelativeUrlT m b) -> RelativeUrlT m b #

generalBracket :: HasCallStack => RelativeUrlT m a -> (a -> ExitCase b -> RelativeUrlT m c) -> (a -> RelativeUrlT m b) -> RelativeUrlT m (b, c) #

MonadThrow m => MonadThrow (RelativeUrlT m) Source #

Instance details

Defined in Data.Url

Methods

throwM :: (HasCallStack, Exception e) => e -> RelativeUrlT m a #

MonadLogger m => MonadLogger (RelativeUrlT m) Source #

Instance details

Defined in Data.Url

Methods

monadLoggerLog :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> RelativeUrlT m () #

MonadCont m => MonadCont (RelativeUrlT m) Source #

Instance details

Defined in Data.Url

Methods

callCC :: ((a -> RelativeUrlT m b) -> RelativeUrlT m a) -> RelativeUrlT m a #

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

Instance details

Defined in Data.Url

Methods

liftResourceT :: ResourceT IO a -> RelativeUrlT m a #

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

Instance details

Defined in Data.Url

Methods

showsPrec :: Int -> RelativeUrlT m a -> ShowS #

show :: RelativeUrlT m a -> String #

showList :: [RelativeUrlT m a] -> ShowS #

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

Instance details

Defined in Data.Url

Methods

(==) :: RelativeUrlT m a -> RelativeUrlT m a -> Bool #

(/=) :: RelativeUrlT m a -> RelativeUrlT m a -> Bool #

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

Instance details

Defined in Data.Url

Methods

compare :: RelativeUrlT m a -> RelativeUrlT m a -> Ordering #

(<) :: RelativeUrlT m a -> RelativeUrlT m a -> Bool #

(<=) :: RelativeUrlT m a -> RelativeUrlT m a -> Bool #

(>) :: RelativeUrlT m a -> RelativeUrlT m a -> Bool #

(>=) :: RelativeUrlT m a -> RelativeUrlT m a -> Bool #

max :: RelativeUrlT m a -> RelativeUrlT m a -> RelativeUrlT m a #

min :: RelativeUrlT m a -> RelativeUrlT m a -> RelativeUrlT m a #

type StT RelativeUrlT a Source #

Instance details

Defined in Data.Url

type StT RelativeUrlT a = a

type StM (RelativeUrlT m) a Source #

Instance details

Defined in Data.Url

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

type RelativeUrl = RelativeUrlT Identity Source #

Grounded Urls

newtype GroundedUrlT (m :: Type -> Type) a Source #

Grounded urls mean that, while omiting host information, paths start with a /, like /foo.

Constructors

GroundedUrlT
Fields runGroundedUrlT :: m a

Instances

Instances details

MMonad GroundedUrlT Source #

Instance details

Defined in Data.Url

Methods

embed :: forall (n :: Type -> Type) m b. Monad n => (forall a. m a -> GroundedUrlT n a) -> GroundedUrlT m b -> GroundedUrlT n b #

MonadTransControl GroundedUrlT Source #

Instance details

Defined in Data.Url

Associated Types

type StT GroundedUrlT a
Instance details Defined in Data.Url type StT GroundedUrlT a = a

Methods

liftWith :: Monad m => (Run GroundedUrlT -> m a) -> GroundedUrlT m a #

restoreT :: Monad m => m (StT GroundedUrlT a) -> GroundedUrlT m a #

MonadTrans GroundedUrlT Source #

Instance details

Defined in Data.Url

Methods

lift :: Monad m => m a -> GroundedUrlT m a #

MFunctor GroundedUrlT Source #

Instance details

Defined in Data.Url

Methods

hoist :: Monad m => (forall a. m a -> n a) -> GroundedUrlT m b -> GroundedUrlT n b #

MonadTransControl GroundedUrlT Identity Source #

Instance details

Defined in Data.Url

Methods

liftWith :: Monad m => (Run GroundedUrlT Identity -> m a) -> GroundedUrlT m a #

restoreT :: Monad m => m (Identity a) -> GroundedUrlT m a #

(MonadReader r m, MonadWriter w m, MonadState s m) => MonadRWS r w s (GroundedUrlT m) Source #

Instance details

Defined in Data.Url

MonadBaseControl b m => MonadBaseControl b (GroundedUrlT m) Source #

Instance details

Defined in Data.Url

Methods

liftBaseWith :: (RunInBase (GroundedUrlT m) b -> b a) -> GroundedUrlT m a #

restoreM :: StM (GroundedUrlT m) a -> GroundedUrlT m a #

MonadError e m => MonadError e (GroundedUrlT m) Source #

Instance details

Defined in Data.Url

Methods

throwError :: e -> GroundedUrlT m a #

catchError :: GroundedUrlT m a -> (e -> GroundedUrlT m a) -> GroundedUrlT m a #

MonadReader r m => MonadReader r (GroundedUrlT m) Source #

Instance details

Defined in Data.Url

Methods

ask :: GroundedUrlT m r #

local :: (r -> r) -> GroundedUrlT m a -> GroundedUrlT m a #

reader :: (r -> a) -> GroundedUrlT m a #

MonadState s m => MonadState s (GroundedUrlT m) Source #

Instance details

Defined in Data.Url

Methods

get :: GroundedUrlT m s #

put :: s -> GroundedUrlT m () #

state :: (s -> (a, s)) -> GroundedUrlT m a #

MonadWriter w m => MonadWriter w (GroundedUrlT m) Source #

Instance details

Defined in Data.Url

Methods

writer :: (a, w) -> GroundedUrlT m a #

tell :: w -> GroundedUrlT m () #

listen :: GroundedUrlT m a -> GroundedUrlT m (a, w) #

pass :: GroundedUrlT m (a, w -> w) -> GroundedUrlT m a #

MonadBase b m => MonadBase b (GroundedUrlT m) Source #

Instance details

Defined in Data.Url

Methods

liftBase :: b α -> GroundedUrlT m α #

Applicative m => MonadUrl Abs (GroundedUrlT m) Source #

Instance details

Defined in Data.Url

Methods

locToUrl :: Location Abs -> GroundedUrlT m URL Source #

MonadBaseControl b m stM => MonadBaseControl b (GroundedUrlT m) (Compose stM Identity) Source #

Instance details

Defined in Data.Url

Methods

liftBaseWith :: (RunInBase (GroundedUrlT m) b (Compose stM Identity) -> b a) -> GroundedUrlT m a #

restoreM :: Compose stM Identity a -> GroundedUrlT m a #

MonadFix m => MonadFix (GroundedUrlT m) Source #

Instance details

Defined in Data.Url

Methods

mfix :: (a -> GroundedUrlT m a) -> GroundedUrlT m a #

MonadIO m => MonadIO (GroundedUrlT m) Source #

Instance details

Defined in Data.Url

Methods

liftIO :: IO a -> GroundedUrlT m a #

Alternative m => Alternative (GroundedUrlT m) Source #

Instance details

Defined in Data.Url

Methods

empty :: GroundedUrlT m a #

(<|>) :: GroundedUrlT m a -> GroundedUrlT m a -> GroundedUrlT m a #

some :: GroundedUrlT m a -> GroundedUrlT m [a] #

many :: GroundedUrlT m a -> GroundedUrlT m [a] #

Applicative m => Applicative (GroundedUrlT m) Source #

Instance details

Defined in Data.Url

Methods

pure :: a -> GroundedUrlT m a #

(<*>) :: GroundedUrlT m (a -> b) -> GroundedUrlT m a -> GroundedUrlT m b #

liftA2 :: (a -> b -> c) -> GroundedUrlT m a -> GroundedUrlT m b -> GroundedUrlT m c #

(*>) :: GroundedUrlT m a -> GroundedUrlT m b -> GroundedUrlT m b #

(<*) :: GroundedUrlT m a -> GroundedUrlT m b -> GroundedUrlT m a #

Functor m => Functor (GroundedUrlT m) Source #

Instance details

Defined in Data.Url

Methods

fmap :: (a -> b) -> GroundedUrlT m a -> GroundedUrlT m b #

(<$) :: a -> GroundedUrlT m b -> GroundedUrlT m a #

Monad m => Monad (GroundedUrlT m) Source #

Instance details

Defined in Data.Url

Methods

(>>=) :: GroundedUrlT m a -> (a -> GroundedUrlT m b) -> GroundedUrlT m b #

(>>) :: GroundedUrlT m a -> GroundedUrlT m b -> GroundedUrlT m b #

return :: a -> GroundedUrlT m a #

MonadPlus m => MonadPlus (GroundedUrlT m) Source #

Instance details

Defined in Data.Url

Methods

mzero :: GroundedUrlT m a #

mplus :: GroundedUrlT m a -> GroundedUrlT m a -> GroundedUrlT m a #

MonadCatch m => MonadCatch (GroundedUrlT m) Source #

Instance details

Defined in Data.Url

Methods

catch :: (HasCallStack, Exception e) => GroundedUrlT m a -> (e -> GroundedUrlT m a) -> GroundedUrlT m a #

MonadMask m => MonadMask (GroundedUrlT m) Source #

Instance details

Defined in Data.Url

Methods

mask :: HasCallStack => ((forall a. GroundedUrlT m a -> GroundedUrlT m a) -> GroundedUrlT m b) -> GroundedUrlT m b #

uninterruptibleMask :: HasCallStack => ((forall a. GroundedUrlT m a -> GroundedUrlT m a) -> GroundedUrlT m b) -> GroundedUrlT m b #

generalBracket :: HasCallStack => GroundedUrlT m a -> (a -> ExitCase b -> GroundedUrlT m c) -> (a -> GroundedUrlT m b) -> GroundedUrlT m (b, c) #

MonadThrow m => MonadThrow (GroundedUrlT m) Source #

Instance details

Defined in Data.Url

Methods

throwM :: (HasCallStack, Exception e) => e -> GroundedUrlT m a #

MonadLogger m => MonadLogger (GroundedUrlT m) Source #

Instance details

Defined in Data.Url

Methods

monadLoggerLog :: ToLogStr msg => Loc -> LogSource -> LogLevel -> msg -> GroundedUrlT m () #

MonadCont m => MonadCont (GroundedUrlT m) Source #

Instance details

Defined in Data.Url

Methods

callCC :: ((a -> GroundedUrlT m b) -> GroundedUrlT m a) -> GroundedUrlT m a #

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

Instance details

Defined in Data.Url

Methods

liftResourceT :: ResourceT IO a -> GroundedUrlT m a #

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

Instance details

Defined in Data.Url

Methods

showsPrec :: Int -> GroundedUrlT m a -> ShowS #

show :: GroundedUrlT m a -> String #

showList :: [GroundedUrlT m a] -> ShowS #

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

Instance details

Defined in Data.Url

Methods

(==) :: GroundedUrlT m a -> GroundedUrlT m a -> Bool #

(/=) :: GroundedUrlT m a -> GroundedUrlT m a -> Bool #

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

Instance details

Defined in Data.Url

Methods

compare :: GroundedUrlT m a -> GroundedUrlT m a -> Ordering #

(<) :: GroundedUrlT m a -> GroundedUrlT m a -> Bool #

(<=) :: GroundedUrlT m a -> GroundedUrlT m a -> Bool #

(>) :: GroundedUrlT m a -> GroundedUrlT m a -> Bool #

(>=) :: GroundedUrlT m a -> GroundedUrlT m a -> Bool #

max :: GroundedUrlT m a -> GroundedUrlT m a -> GroundedUrlT m a #

min :: GroundedUrlT m a -> GroundedUrlT m a -> GroundedUrlT m a #

type StT GroundedUrlT a Source #

Instance details

Defined in Data.Url

type StT GroundedUrlT a = a

type StM (GroundedUrlT m) a Source #

Instance details

Defined in Data.Url

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

type GroundedUrl = GroundedUrlT Identity Source #

Absolute Urls

newtype AbsoluteUrlT (m :: Type -> Type) a Source #

Given a means to take an absolute location and turn it into an URI, make a monad used to construct urls. You can use packLocation to create the Location Abs -> URI function.

Constructors