Nero

This module re-exports the essential functions for quickly writing Nero applications. Use the original modules for more specialized functions.

Request

data Request

An HTTP Request.

Instances

Eq Request

Show Request

Param Request

It traverses the values with the same key both in the query string and the form encoded body of a POST Request.

Formed Request

Payloaded Request

HasQuery Request

HasPath Request

HasHost Request

HasUrl Request

method :: Request -> ByteString

Show Request method.

_GET :: Prism' Request Request

Prism' to filter GET Requests.

>>> dummyRequest ^? _GET <&> method
Just "GET"
>>> dummyRequestForm ^? _GET <&> method
Nothing

_POST :: Prism' Request Request

Prism' to filter for POST Requests.

>>> dummyRequest ^? _POST <&> method
Nothing
>>> dummyRequestForm ^? _POST <&> method
Just "POST"

path :: HasPath a => Lens' a Path

query :: HasQuery a => Lens' a Query

form :: Formed a => Traversal' a Form

params :: Traversal' Request MultiMap

This Traversal lets you traverse every HTTP parameter regardless of whether it's present in the query string or in the form encoded body of a POST Request. In the rare case where there are HTTP parameters in both, every parameter is still being traversed starting from the /query string/.

You might want to use param for traversing a specific parameter.

>>> let request = dummyRequestForm & query . at "name" ?~ ["hello", "out"] & form  . at "name" ?~ ["there"]
>>> foldOf params request ^? ix "name"
Just ["hello","out","there"]

param :: Param a => Text -> Traversal' a Text

Response

data Response

An HTTP response.

Instances

Eq Response

Show Response

HasBody Response

Location Response

ok :: Text -> Response

Creates an 200 OK response from the given text. It automatically encodes the text to 'utf-8'. The Mime type is text/plain.

movedPermanently :: Url -> Response

Creates an 301 Moved Permanently response with the Location corresponding to the given Url.

Matching

match :: Getter Text Match

This is just to pure with a refined type.

prefixed :: Text -> Prism' Match Match

This Prism' strips/prepends a prefix to the first element of a Match.

>>> pure "/hello/there" ^? prefixed "/hello/" . _head
Just "there"

>>> prefixed "/hello/" # pure "there" & view _head
"/hello/there"

If matching the entire source it previews to an empty Text. You might use exact if you are expecting this behavior.

>>> pure "hello" ^? prefixed "hello" . _head
Just ""

This also means that to review an entire source, you need to give it an empty Text.

>>> prefixed "hello" # pure mempty & view _head
"hello"

An empty Match matches to itself regardless of the pattern.

>>> preview (prefixed "hello") (review (prefixed "hello") mempty) <&> is _Empty
Just True

suffixed :: Text -> Prism' Match Match

This Prism' strips/appends a suffix to the first value of a Match.

>>> pure "/hello/there" ^? suffixed "there" . _head
Just "/hello/"

>>> suffixed "there" # pure "/hello/" & view _head
"/hello/there"

If matching the entire source it previews to an empty Text. You might use exact if you are expecting this behavior.

>>> pure "hello" ^? suffixed "hello" . _head
Just ""

This also means that to review an entire source, you need to give it an empty Text.

>>> suffixed "hello" # pure mempty & view _head
"hello"

An empty Match matches to itself regardless of the pattern.

>>> preview (suffixed "hello") (review (suffixed "hello") mempty) <&> is _Empty
Just True

exact :: Text -> Prism' Text ()

This is just an alias to only. Use this to match the entirety of the source. The source mustn't be lifted to a Match.

>>> "hello" ^? exact "hello"
Just ()

sep :: Text -> Prism' Match Match

This Prism' splits/joins at the first occurrence of a boundary for the first value of a Match.

>>> pure "hello/out/there" ^? sep "/" <&> toListOf folded
Just ["out/there","hello"]

>>> sep "/" # (pure "out/there" <> pure "hello") & view _head
"hello/out/there"

Notice what happens when there is no source before or after a boundary:

>>> pure "hello/" ^? sep "/"
Just ["","hello"]
>>> (pure "hello/" <> pure "there") ^? sep "/"
Just ["","hello","there"]

>>> pure "/hello" ^? sep "/"
Just ["hello",""]
>>> (pure "/hello" <> pure "there") ^? sep "/"
Just ["hello","","there"]

When the source is identical to the boundary: >>> pure "hello" ^? sep "hello" Just []

Results handling

class Target a where

Prism' between a Match and a target type.

Methods

target :: Prism' Match a

Instances

Target Float

Target Int

Target Text

Target Match

(Target a, Target b) => Target (a, b)

Testing

dummyRequest :: Request

An empty GET request useful for testing.

dummyRequestForm :: Request

An empty POST request with an empty form encoded body useful for testing.

dummyUrl :: Url

Empty Url useful for testing.

Re-exports

Control.Applicative re-exports <$>, <*>, pure

Data.Foldable re-exports fold

Data.Monoid re-exports Monoid, <>, mappend, mempty

Control.Lens

module Nero.Prelude