Safe Haskell	Safe-Inferred
Language	Haskell2010

Dormouse.Uri

Synopsis

data UriReference
- = Absolute
- | Relative
data Authority = Authority {
- authorityUserInfo :: Maybe UserInfo
- authorityHost :: Host
- authorityPort :: Maybe Int
}
newtype Fragment = Fragment {
- unFragment :: Text
}
newtype Host = Host {
- unHost :: Text
}
newtype Path (ref :: UriReference) = Path {
- unPath :: [PathSegment]
}
newtype PathSegment = PathSegment {
- unPathSegment :: Text
}
newtype Query = Query {
- unQuery :: Text
}
newtype Scheme = Scheme {
- unScheme :: Text
}
newtype Username = Username {
- unUsername :: Text
}
newtype Password = Password {
- unPassword :: Text
}
data UserInfo = UserInfo {
- userInfoUsername :: Username
- userInfoPassword :: Maybe Password
}
data Uri
- = AbsoluteUri AbsUri
- | RelativeUri RelUri
data AbsUri = AbsUri {
- uriScheme :: Scheme
- uriAuthority :: Maybe Authority
- uriPath :: Path 'Absolute
- uriQuery :: Maybe Query
- uriFragment :: Maybe Fragment
}
data RelUri = RelUri {
- uriPath :: Path 'Relative
- uriQuery :: Maybe Query
- uriFragment :: Maybe Fragment
}
parseUri :: MonadThrow m => ByteString -> m Uri

Documentation

data UriReference Source #

Constructors

Absolute
Relative

data Authority Source #

The Authority component of a URI

Constructors

Authority
Fields authorityUserInfo :: Maybe UserInfo authorityHost :: Host authorityPort :: Maybe Int

Instances

Instances details

Eq Authority Source #
Instance details Defined in Dormouse.Uri.Types Methods (==) :: Authority -> Authority -> Bool # (/=) :: Authority -> Authority -> Bool #
Show Authority Source #
Instance details Defined in Dormouse.Uri.Types Methods showsPrec :: Int -> Authority -> ShowS # show :: Authority -> String # showList :: [Authority] -> ShowS #
Lift Authority Source #
Instance details Defined in Dormouse.Uri.Types Methods lift :: Authority -> Q Exp # liftTyped :: Authority -> Q (TExp Authority) #

newtype Fragment Source #

The Fragment component of a URI

Constructors

Fragment
Fields unFragment :: Text

Instances

Instances details

Eq Fragment Source #
Instance details Defined in Dormouse.Uri.Types Methods (==) :: Fragment -> Fragment -> Bool # (/=) :: Fragment -> Fragment -> Bool #
Show Fragment Source #
Instance details Defined in Dormouse.Uri.Types Methods showsPrec :: Int -> Fragment -> ShowS # show :: Fragment -> String # showList :: [Fragment] -> ShowS #
IsString Fragment Source #
Instance details Defined in Dormouse.Uri.Types Methods fromString :: String -> Fragment #
Lift Fragment Source #
Instance details Defined in Dormouse.Uri.Types Methods lift :: Fragment -> Q Exp # liftTyped :: Fragment -> Q (TExp Fragment) #

newtype Host Source #

The Host subcomponent of a URI Authority

Constructors

Host
Fields unHost :: Text

Instances

Instances details

Eq Host Source #
Instance details Defined in Dormouse.Uri.Types Methods (==) :: Host -> Host -> Bool # (/=) :: Host -> Host -> Bool #
Show Host Source #
Instance details Defined in Dormouse.Uri.Types Methods showsPrec :: Int -> Host -> ShowS # show :: Host -> String # showList :: [Host] -> ShowS #
IsString Host Source #
Instance details Defined in Dormouse.Uri.Types Methods fromString :: String -> Host #
Lift Host Source #
Instance details Defined in Dormouse.Uri.Types Methods lift :: Host -> Q Exp # liftTyped :: Host -> Q (TExp Host) #

newtype Path (ref :: UriReference) Source #

The Path component of a URI, including a series of individual Path Segments

Constructors

Path
Fields unPath :: [PathSegment]

Instances

Instances details

Lift (Path ref :: Type) Source #
Instance details Defined in Dormouse.Uri.Types Methods lift :: Path ref -> Q Exp # liftTyped :: Path ref -> Q (TExp (Path ref)) #
Eq (Path ref) Source #
Instance details Defined in Dormouse.Uri.Types Methods (==) :: Path ref -> Path ref -> Bool # (/=) :: Path ref -> Path ref -> Bool #
Show (Path ref) Source #
Instance details Defined in Dormouse.Uri.Types Methods showsPrec :: Int -> Path ref -> ShowS # show :: Path ref -> String # showList :: [Path ref] -> ShowS #

newtype PathSegment Source #

An individial Path segment of a URI

Constructors

PathSegment
Fields unPathSegment :: Text

Instances

Instances details

Eq PathSegment Source #
Instance details Defined in Dormouse.Uri.Types Methods (==) :: PathSegment -> PathSegment -> Bool # (/=) :: PathSegment -> PathSegment -> Bool #
Show PathSegment Source #
Instance details Defined in Dormouse.Uri.Types Methods showsPrec :: Int -> PathSegment -> ShowS # show :: PathSegment -> String # showList :: [PathSegment] -> ShowS #
IsString PathSegment Source #
Instance details Defined in Dormouse.Uri.Types Methods fromString :: String -> PathSegment #
Lift PathSegment Source #
Instance details Defined in Dormouse.Uri.Types Methods lift :: PathSegment -> Q Exp # liftTyped :: PathSegment -> Q (TExp PathSegment) #

newtype Query Source #

The Query component of a URI

Constructors

Query
Fields unQuery :: Text

Instances

Instances details

Eq Query Source #
Instance details Defined in Dormouse.Uri.Types Methods (==) :: Query -> Query -> Bool # (/=) :: Query -> Query -> Bool #
Show Query Source #
Instance details Defined in Dormouse.Uri.Types Methods showsPrec :: Int -> Query -> ShowS # show :: Query -> String # showList :: [Query] -> ShowS #
IsString Query Source #
Instance details Defined in Dormouse.Uri.Types Methods fromString :: String -> Query #
Lift Query Source #
Instance details Defined in Dormouse.Uri.Types Methods lift :: Query -> Q Exp # liftTyped :: Query -> Q (TExp Query) #

newtype Scheme Source #

The Scheme component of a URI

Constructors

Scheme
Fields unScheme :: Text

Instances

Instances details

Eq Scheme Source #
Instance details Defined in Dormouse.Uri.Types Methods (==) :: Scheme -> Scheme -> Bool # (/=) :: Scheme -> Scheme -> Bool #
Show Scheme Source #
Instance details Defined in Dormouse.Uri.Types Methods showsPrec :: Int -> Scheme -> ShowS # show :: Scheme -> String # showList :: [Scheme] -> ShowS #
Lift Scheme Source #
Instance details Defined in Dormouse.Uri.Types Methods lift :: Scheme -> Q Exp # liftTyped :: Scheme -> Q (TExp Scheme) #

newtype Username Source #

The Username subcomponent of a URI UserInfo

Constructors

Username
Fields unUsername :: Text

Instances

Instances details

Eq Username Source #
Instance details Defined in Dormouse.Uri.Types Methods (==) :: Username -> Username -> Bool # (/=) :: Username -> Username -> Bool #
Show Username Source #
Instance details Defined in Dormouse.Uri.Types Methods showsPrec :: Int -> Username -> ShowS # show :: Username -> String # showList :: [Username] -> ShowS #
IsString Username Source #
Instance details Defined in Dormouse.Uri.Types Methods fromString :: String -> Username #
Lift Username Source #
Instance details Defined in Dormouse.Uri.Types Methods lift :: Username -> Q Exp # liftTyped :: Username -> Q (TExp Username) #

newtype Password Source #

The Password subcomponent of a URI UserInfo

Constructors

Password
Fields unPassword :: Text

Instances

Instances details

Eq Password Source #
Instance details Defined in Dormouse.Uri.Types Methods (==) :: Password -> Password -> Bool # (/=) :: Password -> Password -> Bool #
Show Password Source #
Instance details Defined in Dormouse.Uri.Types Methods showsPrec :: Int -> Password -> ShowS # show :: Password -> String # showList :: [Password] -> ShowS #
IsString Password Source #
Instance details Defined in Dormouse.Uri.Types Methods fromString :: String -> Password #
Lift Password Source #
Instance details Defined in Dormouse.Uri.Types Methods lift :: Password -> Q Exp # liftTyped :: Password -> Q (TExp Password) #

data UserInfo Source #

The UserInfo subcomponent of a URI Authority

Constructors

UserInfo
Fields userInfoUsername :: Username userInfoPassword :: Maybe Password

Instances

Instances details

Eq UserInfo Source #
Instance details Defined in Dormouse.Uri.Types Methods (==) :: UserInfo -> UserInfo -> Bool # (/=) :: UserInfo -> UserInfo -> Bool #
Show UserInfo Source #
Instance details Defined in Dormouse.Uri.Types Methods showsPrec :: Int -> UserInfo -> ShowS # show :: UserInfo -> String # showList :: [UserInfo] -> ShowS #
Lift UserInfo Source #
Instance details Defined in Dormouse.Uri.Types Methods lift :: UserInfo -> Q Exp # liftTyped :: UserInfo -> Q (TExp UserInfo) #

data Uri Source #

A Uniform Resource Identifier (URI) is a compact sequence of characters that identifies an abstract or physical resource. It is defined according to RFC 3986 (https://tools.ietf.org/html/rfc3986). URIs can be absolute (i.e. defined against a specific scheme) or relative.

Constructors

AbsoluteUri AbsUri
RelativeUri RelUri

Instances

Instances details

Eq Uri Source #
Instance details Defined in Dormouse.Uri.Types Methods (==) :: Uri -> Uri -> Bool # (/=) :: Uri -> Uri -> Bool #
Show Uri Source #
Instance details Defined in Dormouse.Uri.Types Methods showsPrec :: Int -> Uri -> ShowS # show :: Uri -> String # showList :: [Uri] -> ShowS #
Lift Uri Source #
Instance details Defined in Dormouse.Uri.Types Methods lift :: Uri -> Q Exp # liftTyped :: Uri -> Q (TExp Uri) #

data AbsUri Source #

The data associated with an Absolute URI

Constructors

AbsUri
Fields uriScheme :: Scheme uriAuthority :: Maybe Authority uriPath :: Path 'Absolute uriQuery :: Maybe Query uriFragment :: Maybe Fragment

Instances

Instances details

Eq AbsUri Source #
Instance details Defined in Dormouse.Uri.Types Methods (==) :: AbsUri -> AbsUri -> Bool # (/=) :: AbsUri -> AbsUri -> Bool #
Show AbsUri Source #
Instance details Defined in Dormouse.Uri.Types Methods showsPrec :: Int -> AbsUri -> ShowS # show :: AbsUri -> String # showList :: [AbsUri] -> ShowS #
Lift AbsUri Source #
Instance details Defined in Dormouse.Uri.Types Methods lift :: AbsUri -> Q Exp # liftTyped :: AbsUri -> Q (TExp AbsUri) #

data RelUri Source #

The data associated with a Relative URI

Constructors

RelUri
Fields uriPath :: Path 'Relative uriQuery :: Maybe Query uriFragment :: Maybe Fragment

Instances

Instances details

Eq RelUri Source #
Instance details Defined in Dormouse.Uri.Types Methods (==) :: RelUri -> RelUri -> Bool # (/=) :: RelUri -> RelUri -> Bool #
Show RelUri Source #
Instance details Defined in Dormouse.Uri.Types Methods showsPrec :: Int -> RelUri -> ShowS # show :: RelUri -> String # showList :: [RelUri] -> ShowS #
Lift RelUri Source #
Instance details Defined in Dormouse.Uri.Types Methods lift :: RelUri -> Q Exp # liftTyped :: RelUri -> Q (TExp RelUri) #

parseUri :: MonadThrow m => ByteString -> m Uri Source #

Parse an ascii ByteString as an absolute uri, throwing a UriException in m if this fails