Safe Haskell	Safe-Inferred
Language	GHC2021

Web.Hyperbole.Data.URI

Contents

URI
- Path
- Query String

Synopsis

data URI = URI {
- uriScheme :: String
- uriAuthority :: Maybe URIAuth
- uriPath :: String
- uriQuery :: String
- uriFragment :: String
}
data URIAuth = URIAuth {
- uriUserInfo :: String
- uriRegName :: String
- uriPort :: String
}
uri :: QuasiQuoter
newtype Path = Path {
- segments :: [Segment]
}
type Segment = Text
path :: Text -> Path
parseURIReference :: String -> Maybe URI
pathUri :: Path -> URI
uriToText :: URI -> Text
pathToText :: Bool -> Path -> Text
queryString :: [(ByteString, Maybe ByteString)] -> QueryString
parseQuery :: ByteString -> Query
queryInsert :: ByteString -> Maybe ByteString -> QueryString -> QueryString
renderQuery :: Bool -> Query -> ByteString
type Query = [QueryItem]
type QueryItem = (ByteString, Maybe ByteString)
(./.) :: URI -> Path -> URI
(.?.) :: URI -> QueryItem -> URI
cleanSegment :: Segment -> Segment
newtype Endpoint a = Endpoint {
- uri :: URI
}

URI

data URI #

Represents a general universal resource identifier using its component parts.

For example, for the URI

  foo://anonymous@www.haskell.org:42/ghc?query#frag

the components are:

Constructors

URI
Fields uriScheme :: String foo: uriAuthority :: Maybe URIAuth //anonymous@www.haskell.org:42 uriPath :: String /ghc uriQuery :: String ?query uriFragment :: String #frag

Instances

Instances details

Data URI
Instance details Defined in Network.URI Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> URI -> c URI # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c URI # toConstr :: URI -> Constr # dataTypeOf :: URI -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c URI) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c URI) # gmapT :: (forall b. Data b => b -> b) -> URI -> URI # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> URI -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> URI -> r # gmapQ :: (forall d. Data d => d -> u) -> URI -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> URI -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> URI -> m URI # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> URI -> m URI # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> URI -> m URI #
Generic URI
Instance details Defined in Network.URI Associated Types type Rep URI :: Type -> Type # Methods from :: URI -> Rep URI x # to :: Rep URI x -> URI #
Show URI
Instance details Defined in Network.URI Methods showsPrec :: Int -> URI -> ShowS # show :: URI -> String # showList :: [URI] -> ShowS #
NFData URI
Instance details Defined in Network.URI Methods rnf :: URI -> () #
Eq URI
Instance details Defined in Network.URI Methods (==) :: URI -> URI -> Bool # (/=) :: URI -> URI -> Bool #
Ord URI
Instance details Defined in Network.URI Methods compare :: URI -> URI -> Ordering # (<) :: URI -> URI -> Bool # (<=) :: URI -> URI -> Bool # (>) :: URI -> URI -> Bool # (>=) :: URI -> URI -> Bool # max :: URI -> URI -> URI # min :: URI -> URI -> URI #
FromParam URI Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods parseParam :: ParamValue -> Either String URI Source # decodeFormValue :: Maybe Text -> Either String URI Source #
ToParam URI Source #
Instance details Defined in Web.Hyperbole.Data.Param Methods toParam :: URI -> ParamValue Source #
FromJSON URI	Since: aeson-2.2.0.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods parseJSON :: Value -> Parser URI # parseJSONList :: Value -> Parser [URI] # omittedField :: Maybe URI #
FromJSONKey URI	Since: aeson-2.2.0.0
Instance details Defined in Data.Aeson.Types.FromJSON Methods fromJSONKey :: FromJSONKeyFunction URI # fromJSONKeyList :: FromJSONKeyFunction [URI] #
ToJSON URI	Since: aeson-2.2.0.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSON :: URI -> Value # toEncoding :: URI -> Encoding # toJSONList :: [URI] -> Value # toEncodingList :: [URI] -> Encoding # omitField :: URI -> Bool #
ToJSONKey URI	Since: aeson-2.2.0.0
Instance details Defined in Data.Aeson.Types.ToJSON Methods toJSONKey :: ToJSONKeyFunction URI # toJSONKeyList :: ToJSONKeyFunction [URI] #
Lift URI
Instance details Defined in Network.URI Methods lift :: Quote m => URI -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => URI -> Code m URI #
type Rep URI
Instance details Defined in Network.URI type Rep URI = D1 ('MetaData "URI" "Network.URI" "ntwrk-r-2.6.4.2-33a473b9" 'False) (C1 ('MetaCons "URI" 'PrefixI 'True) ((S1 ('MetaSel ('Just "uriScheme") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :: S1 ('MetaSel ('Just "uriAuthority") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe URIAuth))) :: (S1 ('MetaSel ('Just "uriPath") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :: (S1 ('MetaSel ('Just "uriQuery") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :: S1 ('MetaSel ('Just "uriFragment") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))))

data URIAuth #

Type for authority value within a URI

Constructors

URIAuth
Fields uriUserInfo :: String anonymous@ uriRegName :: String www.haskell.org uriPort :: String :42

Instances

Instances details

Data URIAuth
Instance details Defined in Network.URI Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> URIAuth -> c URIAuth # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c URIAuth # toConstr :: URIAuth -> Constr # dataTypeOf :: URIAuth -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c URIAuth) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c URIAuth) # gmapT :: (forall b. Data b => b -> b) -> URIAuth -> URIAuth # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> URIAuth -> r # gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> URIAuth -> r # gmapQ :: (forall d. Data d => d -> u) -> URIAuth -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> URIAuth -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> URIAuth -> m URIAuth # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> URIAuth -> m URIAuth # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> URIAuth -> m URIAuth #
Generic URIAuth
Instance details Defined in Network.URI Associated Types type Rep URIAuth :: Type -> Type # Methods from :: URIAuth -> Rep URIAuth x # to :: Rep URIAuth x -> URIAuth #
Show URIAuth
Instance details Defined in Network.URI Methods showsPrec :: Int -> URIAuth -> ShowS # show :: URIAuth -> String # showList :: [URIAuth] -> ShowS #
NFData URIAuth
Instance details Defined in Network.URI Methods rnf :: URIAuth -> () #
Eq URIAuth
Instance details Defined in Network.URI Methods (==) :: URIAuth -> URIAuth -> Bool # (/=) :: URIAuth -> URIAuth -> Bool #
Ord URIAuth
Instance details Defined in Network.URI Methods compare :: URIAuth -> URIAuth -> Ordering # (<) :: URIAuth -> URIAuth -> Bool # (<=) :: URIAuth -> URIAuth -> Bool # (>) :: URIAuth -> URIAuth -> Bool # (>=) :: URIAuth -> URIAuth -> Bool # max :: URIAuth -> URIAuth -> URIAuth # min :: URIAuth -> URIAuth -> URIAuth #
Lift URIAuth
Instance details Defined in Network.URI Methods lift :: Quote m => URIAuth -> m Exp # liftTyped :: forall (m :: Type -> Type). Quote m => URIAuth -> Code m URIAuth #
type Rep URIAuth
Instance details Defined in Network.URI type Rep URIAuth = D1 ('MetaData "URIAuth" "Network.URI" "ntwrk-r-2.6.4.2-33a473b9" 'False) (C1 ('MetaCons "URIAuth" 'PrefixI 'True) (S1 ('MetaSel ('Just "uriUserInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :: (S1 ('MetaSel ('Just "uriRegName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String) :: S1 ('MetaSel ('Just "uriPort") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String))))

uri :: QuasiQuoter #

uri is a quasi quoter for staticURI.

>>> [uri|http://www.google.com/|]
http://www.google.com/

>>> [uri|http://www.google.com/##|]

<interactive>...
... Invalid URI: http://www.google.com/##
...

Path

newtype Path Source #

Constructors

Path
Fields segments :: [Segment]

Instances

Instances details

IsString Path Source #
Instance details Defined in Web.Hyperbole.Data.URI Methods fromString :: String -> Path #
IsList Path Source #
Instance details Defined in Web.Hyperbole.Data.URI Associated Types type Item Path # Methods fromList :: [Item Path] -> Path # fromListN :: Int -> [Item Path] -> Path # toList :: Path -> [Item Path] #
Show Path Source #
Instance details Defined in Web.Hyperbole.Data.URI Methods showsPrec :: Int -> Path -> ShowS # show :: Path -> String # showList :: [Path] -> ShowS #
Eq Path Source #
Instance details Defined in Web.Hyperbole.Data.URI Methods (==) :: Path -> Path -> Bool # (/=) :: Path -> Path -> Bool #
type Item Path Source #
Instance details Defined in Web.Hyperbole.Data.URI type Item Path = Segment

type Segment = Text Source #

path :: Text -> Path Source #

parseURIReference :: String -> Maybe URI #

Parse a URI reference to a URI value. Returns Nothing if the string is not a valid URI reference. (an absolute or relative URI with optional fragment identifier).

pathUri :: Path -> URI Source #

uriToText :: URI -> Text Source #

pathToText :: Bool -> Path -> Text Source #

Query String

queryString :: [(ByteString, Maybe ByteString)] -> QueryString Source #

parseQuery :: ByteString -> Query #

Split out the query string into a list of keys and values. A few importants points:

The result returned is still bytestrings, since we perform no character decoding here. Most likely, you will want to use UTF-8 decoding, but this is left to the user of the library.
Percent decoding errors are ignored. In particular, "%Q" will be output as "%Q".
It decodes '+' characters to ' '

Since: http-types-0.2.0

queryInsert :: ByteString -> Maybe ByteString -> QueryString -> QueryString Source #

renderQuery :: Bool -> Query -> ByteString #

Renders the given Query into a ByteString.

If you want a question mark (?) added to the front of the result, use True.

Since: http-types-0.2.0

type Query = [QueryItem] #

A sequence of QueryItems.

type QueryItem = (ByteString, Maybe ByteString) #

An item from the query string, split up into two parts.

The second part should be Nothing if there was no key-value separator after the query item name.

Since: http-types-0.2.0