UrlPath.Types

Documentation

data GETParam

A GET parameter encoded in a Url.

Constructors

GETParam

Fields

key :: !Text

Key for a get parameter.

val :: !Text

Value for the key.

Instances

Eq GETParam

Show GETParam

renderGETParam :: GETParam -> Text

Render a GET parameter pair.

data UrlString

A Url string - a target page and GET parameters.

Constructors

UrlString

Fields

target :: !Text

Relative base file - eg) "foo.php" in "foo.php?bar=baz".

params :: [GETParam]

GET Parameters.

Instances

Eq UrlString

Show UrlString

Url UrlString AbsoluteUrl

Url UrlString GroundedUrl

Url UrlString RelativeUrl

Monad m => Url UrlString (AbsoluteUrlT m)

Monad m => Url UrlString (GroundedUrlT m)

Monad m => Url UrlString (RelativeUrlT m)

renderUrlString :: UrlString -> Text

Render a Url String simply - this is equivalent to expandRelative.

(<?>) infixl 9

Arguments

:: Text

Target string

-> (Text, Text)

GET Parameter

-> UrlString

Lifts a target path with some GET parameter chunks into a UrlString.

(<&>) infixl 8

Arguments

:: UrlString

Old Url

-> (Text, Text)

Additional GET Parameter

-> UrlString

Adds more GET parameters to a UrlString.

expandRelative :: UrlString -> Text

Render the Url String as relative

expandGrounded :: UrlString -> Text

Render the Url String as grounded

expandAbsolute :: MonadReader Text m => UrlString -> m Text

Render the Url String as absolute - getting the root from a MonadReader.

expandAbsoluteWith :: MonadReader a m => UrlString -> (a -> Text) -> m Text

Render the Url String as absolute, but with your own configuration type.

data SiteConfig = SiteConfig { host :: T.Text
                             , cdnHost :: T.Text
                             }
  deriving (Show, Eq)
          
foo :: HtmlT (Reader SiteConfig) ()
foo = do
  url <- lift $ expandAbsoluteWith ("foo.php" <?> ("bar","baz")) host
  script_ [src_ url] ""

bar :: LT.Text 
bar = (runReader (runTextT foo)) $
  SiteConfig "example.com" "cdn.example.com"

newtype RelativeUrlT m a

Rendering mode transformer. This isn't an instance of UrlReader - to use, simple lift as many levels as you need:

foo :: Monad m => HtmlT (RelativeUrlT m) ()
foo = do
  url <- lift $ renderUrl $ "foo.php" <?> ("bar","baz")
  script_ [src_ url] ""

When rendering foo, simply use the Transformer's run function to convert it to a reader:

bar :: Monad m => m LT.Text
bar = (runRelativeUrlT (renderTextT foo)) "example.com"

It is generally simpler (but more restrictive) to use the non-transformer variety.

Constructors

RelativeUrlT

Fields

runRelativeUrlT :: Text -> m a

Instances

MonadTrans RelativeUrlT

Monad m => MonadReader Text (RelativeUrlT m)

Monad m => Url Text (RelativeUrlT m)

Monad m => Url UrlString (RelativeUrlT m)

Monad m => Monad (RelativeUrlT m)

Functor f => Functor (RelativeUrlT f)

Applicative f => Applicative (RelativeUrlT f)

newtype RelativeUrl a

Concrete Monad for automatically coercing HtmlT's to use a mode of Url rendering (relative, grounded, or absolute).

foo :: HtmlT RelativeUrl ()
foo = do
  url <- lift $ renderUrl $ "foo.php" <?> ("bar","baz")
  script_ [src_ url] ""

when rendering these simple monads for automatic conversion via coercion, use the runUrlReader member function of the UrlReader typeclass:

bar :: LT.Text
bar = (runUrlReader (renderTextT foo)) "example.com"

To change the mode of rendering, simple change the coerced type of foo.

Constructors

RelativeUrl

Fields

runRelativeUrl :: Text -> a

Instances

Monad RelativeUrl

Functor RelativeUrl

Applicative RelativeUrl

UrlReader RelativeUrl

MonadReader Text RelativeUrl

Url Text RelativeUrl

Url UrlString RelativeUrl

newtype GroundedUrlT m a

Constructors

GroundedUrlT

Fields

runGroundedUrlT :: Text -> m a

Instances

MonadTrans GroundedUrlT

Monad m => MonadReader Text (GroundedUrlT m)

Monad m => Url Text (GroundedUrlT m)

Monad m => Url UrlString (GroundedUrlT m)

Monad m => Monad (GroundedUrlT m)

Functor f => Functor (GroundedUrlT f)

Applicative f => Applicative (GroundedUrlT f)

newtype GroundedUrl a

Constructors

GroundedUrl

Fields

runGroundedUrl :: Text -> a

Instances

Monad GroundedUrl

Functor GroundedUrl

Applicative GroundedUrl

UrlReader GroundedUrl

MonadReader Text GroundedUrl

Url Text GroundedUrl

Url UrlString GroundedUrl

newtype AbsoluteUrlT m a

Constructors

AbsoluteUrlT

Fields

runAbsoluteUrlT :: Text -> m a

Instances

MonadTrans AbsoluteUrlT

Monad m => MonadReader Text (AbsoluteUrlT m)

Monad m => Url Text (AbsoluteUrlT m)

Monad m => Url UrlString (AbsoluteUrlT m)

Monad m => Monad (AbsoluteUrlT m)

Functor f => Functor (AbsoluteUrlT f)

Applicative f => Applicative (AbsoluteUrlT f)

newtype AbsoluteUrl a

Constructors

AbsoluteUrl

Fields

runAbsoluteUrl :: Text -> a

Instances

Monad AbsoluteUrl

Functor AbsoluteUrl

Applicative AbsoluteUrl

UrlReader AbsoluteUrl

MonadReader Text AbsoluteUrl

Url Text AbsoluteUrl

Url UrlString AbsoluteUrl