on master help sign in
add warning documentation for raw Request fields
a674f58Greg Weber
Network/Wai.hs+3−1
@@ -70,9 +70,11 @@ data Request = Request
70 -- depending on backend; in a standalone server setting, this is most likely
70 -- depending on backend; in a standalone server setting, this is most likely
71 -- all information after the domain name. In a CGI application, this would be
71 -- all information after the domain name. In a CGI application, this would be
72 -- the information following the path to the CGI executable itself.
72 -- the information following the path to the CGI executable itself.
73+ -- Do not modify this raw value- modify pathInfo instead.
73 , rawPathInfo :: B.ByteString
74 , rawPathInfo :: B.ByteString
74 -- | If no query string was specified, this should be empty. This value
75 -- | If no query string was specified, this should be empty. This value
75 -- /will/ include the leading question mark.
76 -- /will/ include the leading question mark.
77+ -- Do not modify this raw value- modify queryString instead.
76 , rawQueryString :: B.ByteString
78 , rawQueryString :: B.ByteString
77 -- | Generally the host requested by the user via the Host request header.
79 -- | Generally the host requested by the user via the Host request header.
78 -- Backends are free to provide alternative values as necessary. This value
80 -- Backends are free to provide alternative values as necessary. This value
@@ -88,7 +90,7 @@ data Request = Request
88 , isSecure :: Bool
90 , isSecure :: Bool
89 -- | The client\'s host information.
91 -- | The client\'s host information.
90 , remoteHost :: SockAddr
92 , remoteHost :: SockAddr
91− -- | Path info, broken down into individual components.
93+ -- | Path info in individual pieces- the url without a hostname/port and without a query string, split on forward slashes,
92 , pathInfo :: [Text]
94 , pathInfo :: [Text]
93 -- | Parsed query string information
95 -- | Parsed query string information
94 , queryString :: H.Query
96 , queryString :: H.Query