Copyright	© 2017–2018 Mark Karpov
License	BSD 3 clause
Maintainer	Mark Karpov <markkarpov92@gmail.com>
Stability	experimental
Portability	portable
Safe Haskell	None
Language	Haskell2010

Text.URI

Contents

Data types
Refined text
Parsing
Rendering

Description

This is a modern library for working with URIs as per RFC 3986:

https://tools.ietf.org/html/rfc3986

This module is intended to be imported qualified, e.g.:

import Text.URI (URI)
import qualified Text.URI as URI

See also Text.URI.Lens for lens, prisms, and traversals; see Text.URI.QQ for quasi-quoters for compile-time validation of URIs and refined text components.

Synopsis

data URI = URI {
- uriScheme :: Maybe (RText Scheme)
- uriAuthority :: Either Bool Authority
- uriPath :: Maybe (Bool, NonEmpty (RText PathPiece))
- uriQuery :: [QueryParam]
- uriFragment :: Maybe (RText Fragment)
}
mkURI :: MonadThrow m => Text -> m URI
emptyURI :: URI
makeAbsolute :: RText Scheme -> URI -> URI
isPathAbsolute :: URI -> Bool
relativeTo :: URI -> URI -> Maybe URI
data Authority = Authority {
- authUserInfo :: Maybe UserInfo
- authHost :: RText Host
- authPort :: Maybe Word
}
data UserInfo = UserInfo {
- uiUsername :: RText Username
- uiPassword :: Maybe (RText Password)
}
data QueryParam
- = QueryFlag (RText QueryKey)
- | QueryParam (RText QueryKey) (RText QueryValue)
data ParseException = ParseException Text (ParseError Char Void)
data RText (l :: RTextLabel)
data RTextLabel
- = Scheme
- | Host
- | Username
- | Password
- | PathPiece
- | QueryKey
- | QueryValue
- | Fragment
mkScheme :: MonadThrow m => Text -> m (RText Scheme)
mkHost :: MonadThrow m => Text -> m (RText Host)
mkUsername :: MonadThrow m => Text -> m (RText Username)
mkPassword :: MonadThrow m => Text -> m (RText Password)
mkPathPiece :: MonadThrow m => Text -> m (RText PathPiece)
mkQueryKey :: MonadThrow m => Text -> m (RText QueryKey)
mkQueryValue :: MonadThrow m => Text -> m (RText QueryValue)
mkFragment :: MonadThrow m => Text -> m (RText Fragment)
unRText :: RText l -> Text
data RTextException = RTextException RTextLabel Text
parser :: MonadParsec e Text m => m URI
parserBs :: MonadParsec e ByteString m => m URI
render :: URI -> Text
render' :: URI -> Builder
renderBs :: URI -> ByteString
renderBs' :: URI -> Builder
renderStr :: URI -> String
renderStr' :: URI -> ShowS

Data types

data URI Source #

Uniform resource identifier (URI) reference. We use refined Text (RText l) here because information is presented in human-readable form, i.e. percent-decoded, and thus it may contain Unicode characters.

Constructors

URI

Fields

uriScheme :: Maybe (RText Scheme)
URI scheme, if Nothing, then the URI reference is relative
uriAuthority :: Either Bool Authority
Authority component in Right or a Bool value in Left indicating if uriPath path is absolute (True) or relative (False); if we have an Authority component, then the path is necessarily absolute, see isPathAbsolute
Note: before version 0.1.0.0 type of uriAuthority was Maybe Authority
uriPath :: Maybe (Bool, NonEmpty (RText PathPiece))
Nothing represents the empty path, while Just contains an indication Bool whether the path component has a trailing slash, and the collection of path pieces NonEmpty (RText PathPiece).
Note: before version 0.2.0.0 type of uriPath was [RText PathPiece].
uriQuery :: [QueryParam]
Query parameters, RFC 3986 does not define the inner organization of query string, so we deconstruct it following RFC 1866 here
uriFragment :: Maybe (RText Fragment)
Fragment, without #

Instances

Eq URI Source #
Instance details Defined in Text.URI.Types Methods (==) :: URI -> URI -> Bool # (/=) :: URI -> URI -> Bool #
Data URI Source #
Instance details Defined in Text.URI.Types 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 :: (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 #
Ord URI Source #
Instance details Defined in Text.URI.Types 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 #
Show URI Source #
Instance details Defined in Text.URI.Types Methods showsPrec :: Int -> URI -> ShowS # show :: URI -> String # showList :: [URI] -> ShowS #
Generic URI Source #
Instance details Defined in Text.URI.Types Associated Types type Rep URI :: * -> * # Methods from :: URI -> Rep URI x # to :: Rep URI x -> URI #
Arbitrary URI Source #
Instance details Defined in Text.URI.Types Methods arbitrary :: Gen URI # shrink :: URI -> [URI] #
NFData URI Source #
Instance details Defined in Text.URI.Types Methods rnf :: URI -> () #
type Rep URI Source #
Instance details Defined in Text.URI.Types type Rep URI = D1 (MetaData "URI" "Text.URI.Types" "modern-uri-0.2.2.0-8czTIJh6ioK6a7UxchMBZk" False) (C1 (MetaCons "URI" PrefixI True) ((S1 (MetaSel (Just "uriScheme") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (RText Scheme))) :: S1 (MetaSel (Just "uriAuthority") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Either Bool Authority))) :: (S1 (MetaSel (Just "uriPath") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (Bool, NonEmpty (RText PathPiece)))) :: (S1 (MetaSel (Just "uriQuery") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [QueryParam]) :: S1 (MetaSel (Just "uriFragment") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (RText Fragment)))))))

mkURI :: MonadThrow m => Text -> m URI Source #

Construct a URI from Text. The input you pass to mkURI must be a valid URI as per RFC 3986, that is, its components should be percent-encoded where necessary. In case of parse failure ParseException is thrown.

This function uses the parser parser under the hood, which you can also use directly in a Megaparsec parser.

emptyURI :: URI Source #

The empty URI.

Since: modern-uri-0.2.1.0

makeAbsolute :: RText Scheme -> URI -> URI Source #

Make a given URI reference absolute using the supplied RText Scheme if necessary.

isPathAbsolute :: URI -> Bool Source #

Return True if path in a given URI is absolute.

Since: modern-uri-0.1.0.0

relativeTo Source #

Arguments

:: URI	Reference `URI` to make absolute
-> URI	Base `URI`
-> Maybe URI	The target `URI`

relativeTo reference base makes the reference URI absolute resolving it against the base URI.

If the base URI is not absolute itself (that is, it has no scheme), this function returns Nothing.

Since: modern-uri-0.2.0.0

data Authority Source #

Authority component of URI.

Constructors

Authority
Fields authUserInfo :: Maybe UserInfo User information authHost :: RText Host Host authPort :: Maybe Word Port number

Instances

Eq Authority Source #
Instance details Defined in Text.URI.Types Methods (==) :: Authority -> Authority -> Bool # (/=) :: Authority -> Authority -> Bool #
Data Authority Source #
Instance details Defined in Text.URI.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Authority -> c Authority # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Authority # toConstr :: Authority -> Constr # dataTypeOf :: Authority -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Authority) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Authority) # gmapT :: (forall b. Data b => b -> b) -> Authority -> Authority # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Authority -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Authority -> r # gmapQ :: (forall d. Data d => d -> u) -> Authority -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> Authority -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> Authority -> m Authority # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Authority -> m Authority # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Authority -> m Authority #
Ord Authority Source #
Instance details Defined in Text.URI.Types Methods compare :: Authority -> Authority -> Ordering # (<) :: Authority -> Authority -> Bool # (<=) :: Authority -> Authority -> Bool # (>) :: Authority -> Authority -> Bool # (>=) :: Authority -> Authority -> Bool # max :: Authority -> Authority -> Authority # min :: Authority -> Authority -> Authority #
Show Authority Source #
Instance details Defined in Text.URI.Types Methods showsPrec :: Int -> Authority -> ShowS # show :: Authority -> String # showList :: [Authority] -> ShowS #
Generic Authority Source #
Instance details Defined in Text.URI.Types Associated Types type Rep Authority :: * -> * # Methods from :: Authority -> Rep Authority x # to :: Rep Authority x -> Authority #
Arbitrary Authority Source #
Instance details Defined in Text.URI.Types Methods arbitrary :: Gen Authority # shrink :: Authority -> [Authority] #
NFData Authority Source #
Instance details Defined in Text.URI.Types Methods rnf :: Authority -> () #
type Rep Authority Source #
Instance details Defined in Text.URI.Types type Rep Authority = D1 (MetaData "Authority" "Text.URI.Types" "modern-uri-0.2.2.0-8czTIJh6ioK6a7UxchMBZk" False) (C1 (MetaCons "Authority" PrefixI True) (S1 (MetaSel (Just "authUserInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe UserInfo)) :: (S1 (MetaSel (Just "authHost") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (RText Host)) :: S1 (MetaSel (Just "authPort") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe Word)))))

data UserInfo Source #

User info as a combination of username and password.

Constructors

UserInfo
Fields uiUsername :: RText Username Username uiPassword :: Maybe (RText Password) Password, `Nothing` means that there was no `:` character in the user info string

Instances

Eq UserInfo Source #
Instance details Defined in Text.URI.Types Methods (==) :: UserInfo -> UserInfo -> Bool # (/=) :: UserInfo -> UserInfo -> Bool #
Data UserInfo Source #
Instance details Defined in Text.URI.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UserInfo -> c UserInfo # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UserInfo # toConstr :: UserInfo -> Constr # dataTypeOf :: UserInfo -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UserInfo) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UserInfo) # gmapT :: (forall b. Data b => b -> b) -> UserInfo -> UserInfo # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UserInfo -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UserInfo -> r # gmapQ :: (forall d. Data d => d -> u) -> UserInfo -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> UserInfo -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> UserInfo -> m UserInfo # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UserInfo -> m UserInfo # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UserInfo -> m UserInfo #
Ord UserInfo Source #
Instance details Defined in Text.URI.Types Methods compare :: UserInfo -> UserInfo -> Ordering # (<) :: UserInfo -> UserInfo -> Bool # (<=) :: UserInfo -> UserInfo -> Bool # (>) :: UserInfo -> UserInfo -> Bool # (>=) :: UserInfo -> UserInfo -> Bool # max :: UserInfo -> UserInfo -> UserInfo # min :: UserInfo -> UserInfo -> UserInfo #
Show UserInfo Source #
Instance details Defined in Text.URI.Types Methods showsPrec :: Int -> UserInfo -> ShowS # show :: UserInfo -> String # showList :: [UserInfo] -> ShowS #
Generic UserInfo Source #
Instance details Defined in Text.URI.Types Associated Types type Rep UserInfo :: * -> * # Methods from :: UserInfo -> Rep UserInfo x # to :: Rep UserInfo x -> UserInfo #
Arbitrary UserInfo Source #
Instance details Defined in Text.URI.Types Methods arbitrary :: Gen UserInfo # shrink :: UserInfo -> [UserInfo] #
NFData UserInfo Source #
Instance details Defined in Text.URI.Types Methods rnf :: UserInfo -> () #
type Rep UserInfo Source #
Instance details Defined in Text.URI.Types type Rep UserInfo = D1 (MetaData "UserInfo" "Text.URI.Types" "modern-uri-0.2.2.0-8czTIJh6ioK6a7UxchMBZk" False) (C1 (MetaCons "UserInfo" PrefixI True) (S1 (MetaSel (Just "uiUsername") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (RText Username)) :*: S1 (MetaSel (Just "uiPassword") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe (RText Password)))))

data QueryParam Source #

Query parameter either in the form of flag or as a pair of key and value. A key cannot be empty, while a value can.

Constructors

QueryFlag (RText QueryKey)	Flag parameter
QueryParam (RText QueryKey) (RText QueryValue)	Key–value pair

Instances

Eq QueryParam Source #
Instance details Defined in Text.URI.Types Methods (==) :: QueryParam -> QueryParam -> Bool # (/=) :: QueryParam -> QueryParam -> Bool #
Data QueryParam Source #
Instance details Defined in Text.URI.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> QueryParam -> c QueryParam # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c QueryParam # toConstr :: QueryParam -> Constr # dataTypeOf :: QueryParam -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c QueryParam) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c QueryParam) # gmapT :: (forall b. Data b => b -> b) -> QueryParam -> QueryParam # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> QueryParam -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> QueryParam -> r # gmapQ :: (forall d. Data d => d -> u) -> QueryParam -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> QueryParam -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> QueryParam -> m QueryParam # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> QueryParam -> m QueryParam # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> QueryParam -> m QueryParam #
Ord QueryParam Source #
Instance details Defined in Text.URI.Types Methods compare :: QueryParam -> QueryParam -> Ordering # (<) :: QueryParam -> QueryParam -> Bool # (<=) :: QueryParam -> QueryParam -> Bool # (>) :: QueryParam -> QueryParam -> Bool # (>=) :: QueryParam -> QueryParam -> Bool # max :: QueryParam -> QueryParam -> QueryParam # min :: QueryParam -> QueryParam -> QueryParam #
Show QueryParam Source #
Instance details Defined in Text.URI.Types Methods showsPrec :: Int -> QueryParam -> ShowS # show :: QueryParam -> String # showList :: [QueryParam] -> ShowS #
Generic QueryParam Source #
Instance details Defined in Text.URI.Types Associated Types type Rep QueryParam :: * -> * # Methods from :: QueryParam -> Rep QueryParam x # to :: Rep QueryParam x -> QueryParam #
Arbitrary QueryParam Source #
Instance details Defined in Text.URI.Types Methods arbitrary :: Gen QueryParam # shrink :: QueryParam -> [QueryParam] #
NFData QueryParam Source #
Instance details Defined in Text.URI.Types Methods rnf :: QueryParam -> () #
type Rep QueryParam Source #
Instance details Defined in Text.URI.Types type Rep QueryParam = D1 (MetaData "QueryParam" "Text.URI.Types" "modern-uri-0.2.2.0-8czTIJh6ioK6a7UxchMBZk" False) (C1 (MetaCons "QueryFlag" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (RText QueryKey))) :+: C1 (MetaCons "QueryParam" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (RText QueryKey)) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (RText QueryValue))))

data ParseException Source #

Parse exception thrown by mkURI when a given Text value cannot be parsed as a URI.

Constructors

ParseException Text (ParseError Char Void)

Arguments are: original input and parse error

Instances

Eq ParseException Source #
Instance details Defined in Text.URI.Types Methods (==) :: ParseException -> ParseException -> Bool # (/=) :: ParseException -> ParseException -> Bool #
Data ParseException Source #
Instance details Defined in Text.URI.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ParseException -> c ParseException # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ParseException # toConstr :: ParseException -> Constr # dataTypeOf :: ParseException -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ParseException) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ParseException) # gmapT :: (forall b. Data b => b -> b) -> ParseException -> ParseException # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ParseException -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ParseException -> r # gmapQ :: (forall d. Data d => d -> u) -> ParseException -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ParseException -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ParseException -> m ParseException # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ParseException -> m ParseException # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ParseException -> m ParseException #
Show ParseException Source #
Instance details Defined in Text.URI.Types Methods showsPrec :: Int -> ParseException -> ShowS # show :: ParseException -> String # showList :: [ParseException] -> ShowS #
Generic ParseException Source #
Instance details Defined in Text.URI.Types Associated Types type Rep ParseException :: * -> * # Methods from :: ParseException -> Rep ParseException x # to :: Rep ParseException x -> ParseException #
Exception ParseException Source #
Instance details Defined in Text.URI.Types Methods toException :: ParseException -> SomeException # fromException :: SomeException -> Maybe ParseException # displayException :: ParseException -> String #
NFData ParseException Source #
Instance details Defined in Text.URI.Types Methods rnf :: ParseException -> () #
type Rep ParseException Source #
Instance details Defined in Text.URI.Types type Rep ParseException = D1 (MetaData "ParseException" "Text.URI.Types" "modern-uri-0.2.2.0-8czTIJh6ioK6a7UxchMBZk" False) (C1 (MetaCons "ParseException" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (ParseError Char Void))))

Refined text

Refined text values can only be created by using the smart constructors listed below, such as mkScheme. This eliminates the possibility of having an invalid component in URI which could invalidate the whole URI.

Note that the refined text RText type is labelled at the type level with RTextLabels, which see.

When an invalid Text value is passed to a smart constructor, it rejects it by throwing the RTextException. Remember that the Maybe datatype is also an instance of MonadThrow, and so one could as well use the smart constructors in the Maybe monad.

data RText (l :: RTextLabel) Source #

Refined text labelled at the type level.

Instances

Eq (RText l) Source #
Instance details Defined in Text.URI.Types Methods (==) :: RText l -> RText l -> Bool # (/=) :: RText l -> RText l -> Bool #
Typeable l => Data (RText l) Source #
Instance details Defined in Text.URI.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RText l -> c (RText l) # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c (RText l) # toConstr :: RText l -> Constr # dataTypeOf :: RText l -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c (RText l)) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c (RText l)) # gmapT :: (forall b. Data b => b -> b) -> RText l -> RText l # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RText l -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RText l -> r # gmapQ :: (forall d. Data d => d -> u) -> RText l -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> RText l -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RText l -> m (RText l) # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RText l -> m (RText l) # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RText l -> m (RText l) #
Ord (RText l) Source #
Instance details Defined in Text.URI.Types Methods compare :: RText l -> RText l -> Ordering # (<) :: RText l -> RText l -> Bool # (<=) :: RText l -> RText l -> Bool # (>) :: RText l -> RText l -> Bool # (>=) :: RText l -> RText l -> Bool # max :: RText l -> RText l -> RText l # min :: RText l -> RText l -> RText l #
Show (RText l) Source #
Instance details Defined in Text.URI.Types Methods showsPrec :: Int -> RText l -> ShowS # show :: RText l -> String # showList :: [RText l] -> ShowS #
Generic (RText l) Source #
Instance details Defined in Text.URI.Types Associated Types type Rep (RText l) :: * -> * # Methods from :: RText l -> Rep (RText l) x # to :: Rep (RText l) x -> RText l #
Arbitrary (RText Scheme) Source #
Instance details Defined in Text.URI.Types Methods arbitrary :: Gen (RText Scheme) # shrink :: RText Scheme -> [RText Scheme] #
Arbitrary (RText Host) Source #
Instance details Defined in Text.URI.Types Methods arbitrary :: Gen (RText Host) # shrink :: RText Host -> [RText Host] #
Arbitrary (RText Username) Source #
Instance details Defined in Text.URI.Types Methods arbitrary :: Gen (RText Username) # shrink :: RText Username -> [RText Username] #
Arbitrary (RText Password) Source #
Instance details Defined in Text.URI.Types Methods arbitrary :: Gen (RText Password) # shrink :: RText Password -> [RText Password] #
Arbitrary (RText PathPiece) Source #
Instance details Defined in Text.URI.Types Methods arbitrary :: Gen (RText PathPiece) # shrink :: RText PathPiece -> [RText PathPiece] #
Arbitrary (RText QueryKey) Source #
Instance details Defined in Text.URI.Types Methods arbitrary :: Gen (RText QueryKey) # shrink :: RText QueryKey -> [RText QueryKey] #
Arbitrary (RText QueryValue) Source #
Instance details Defined in Text.URI.Types Methods arbitrary :: Gen (RText QueryValue) # shrink :: RText QueryValue -> [RText QueryValue] #
Arbitrary (RText Fragment) Source #
Instance details Defined in Text.URI.Types Methods arbitrary :: Gen (RText Fragment) # shrink :: RText Fragment -> [RText Fragment] #
NFData (RText l) Source #
Instance details Defined in Text.URI.Types Methods rnf :: RText l -> () #
type Rep (RText l) Source #
Instance details Defined in Text.URI.Types type Rep (RText l) = D1 (MetaData "RText" "Text.URI.Types" "modern-uri-0.2.2.0-8czTIJh6ioK6a7UxchMBZk" True) (C1 (MetaCons "RText" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))

data RTextLabel Source #

Refined text labels.

Constructors

Scheme	See `mkScheme`
Host	See `mkHost`
Username	See `mkUsername`
Password	See `mkPassword`
PathPiece	See `mkPathPiece`
QueryKey	See `mkQueryKey`
QueryValue	See `mkQueryValue`
Fragment	See `mkFragment`

Instances

Eq RTextLabel Source #
Instance details Defined in Text.URI.Types Methods (==) :: RTextLabel -> RTextLabel -> Bool # (/=) :: RTextLabel -> RTextLabel -> Bool #
Data RTextLabel Source #
Instance details Defined in Text.URI.Types Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> RTextLabel -> c RTextLabel # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c RTextLabel # toConstr :: RTextLabel -> Constr # dataTypeOf :: RTextLabel -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c RTextLabel) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c RTextLabel) # gmapT :: (forall b. Data b => b -> b) -> RTextLabel -> RTextLabel # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> RTextLabel -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> RTextLabel -> r # gmapQ :: (forall d. Data d => d -> u) -> RTextLabel -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> RTextLabel -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> RTextLabel -> m RTextLabel # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> RTextLabel -> m RTextLabel # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> RTextLabel -> m RTextLabel #
Ord RTextLabel Source #
Instance details Defined in Text.URI.Types Methods compare :: RTextLabel -> RTextLabel -> Ordering # (<) :: RTextLabel -> RTextLabel -> Bool # (<=) :: RTextLabel -> RTextLabel -> Bool # (>) :: RTextLabel -> RTextLabel -> Bool # (>=) :: RTextLabel -> RTextLabel -> Bool # max :: RTextLabel -> RTextLabel -> RTextLabel # min :: RTextLabel -> RTextLabel -> RTextLabel #
Show RTextLabel Source #
Instance details Defined in Text.URI.Types Methods showsPrec :: Int -> RTextLabel -> ShowS # show :: RTextLabel -> String # showList :: [RTextLabel] -> ShowS #
Generic RTextLabel Source #
Instance details Defined in Text.URI.Types Associated Types type Rep RTextLabel :: * -> * # Methods from :: RTextLabel -> Rep RTextLabel x # to :: Rep RTextLabel x -> RTextLabel #
type Rep RTextLabel Source #
Instance details Defined in Text.URI.Types type Rep RTextLabel = D1 (MetaData "RTextLabel" "Text.URI.Types" "modern-uri-0.2.2.0-8czTIJh6ioK6a7UxchMBZk" False) (((C1 (MetaCons "Scheme" PrefixI False) (U1 :: * -> ) :+: C1 (MetaCons "Host" PrefixI False) (U1 :: -> )) :+: (C1 (MetaCons "Username" PrefixI False) (U1 :: -> ) :+: C1 (MetaCons "Password" PrefixI False) (U1 :: -> ))) :+: ((C1 (MetaCons "PathPiece" PrefixI False) (U1 :: -> ) :+: C1 (MetaCons "QueryKey" PrefixI False) (U1 :: -> )) :+: (C1 (MetaCons "QueryValue" PrefixI False) (U1 :: -> ) :+: C1 (MetaCons "Fragment" PrefixI False) (U1 :: -> *))))

mkScheme :: MonadThrow m => Text -> m (RText Scheme) Source #

Lift a Text value into RText Scheme.

Scheme names consist of a sequence of characters beginning with a letter and followed by any combination of letters, digits, plus "+", period ".", or hyphen "-".

This smart constructor performs normalization of valid schemes by converting them to lower case.

mkHost :: MonadThrow m => Text -> m (RText Host) Source #

Lift a Text value into RText Host.

The host sub-component of authority is identified by an IP literal encapsulated within square brackets, an IPv4 address in dotted-decimal form, or a registered name.

This smart constructor performs normalization of valid hosts by converting them to lower case.

mkUsername :: MonadThrow m => Text -> m (RText Username) Source #

Lift a Text value into RText Username.