Safe Haskell	None
Language	Haskell2010

Data.RDF.IRI

Description

An implementation of the RFC3987 [RFC3987]: http://www.ietf.org/rfc/rfc3987.txt

Synopsis

newtype IRI = IRI {
- getIRI :: Text
}
data IRIRef = IRIRef !(Maybe Scheme) !(Maybe Authority) !Path !(Maybe IRIQuery) !(Maybe Fragment)
newtype Scheme = Scheme Text
data Authority = Authority !(Maybe UserInfo) !Host !(Maybe Port)
newtype UserInfo = UserInfo Text
newtype Host = Host Text
newtype Port = Port Int
newtype Path = Path Text
newtype IRIQuery = IRIQuery Text
newtype Fragment = Fragment Text
data IRIError = InvalidIRI
data SchemaError
- = NonAlphaLeading
- | InvalidChars
- | MissingColon
mkIRI :: Text -> Either String IRI
serializeIRI :: IRIRef -> Text
parseIRI :: Text -> Either String IRIRef
parseRelIRI :: Text -> Either String IRIRef
validateIRI :: Text -> Either String Text
resolveIRI :: Text -> Text -> Either String Text
removeIRIFragment :: IRIRef -> IRIRef

Documentation

newtype IRI Source #

A serialized IRI representation.

Constructors

IRI
Fields getIRI :: Text

Instances

Instances details

Eq IRI Source #
Instance details Defined in Data.RDF.IRI Methods (==) :: IRI -> IRI -> Bool # (/=) :: IRI -> IRI -> Bool #
Show IRI Source #
Instance details Defined in Data.RDF.IRI Methods showsPrec :: Int -> IRI -> ShowS # show :: IRI -> String # showList :: [IRI] -> ShowS #

data IRIRef Source #

A detailed IRI representation with its components.

Constructors

IRIRef !(Maybe Scheme) !(Maybe Authority) !Path !(Maybe IRIQuery) !(Maybe Fragment)

Instances

Instances details

Eq IRIRef Source #
Instance details Defined in Data.RDF.IRI Methods (==) :: IRIRef -> IRIRef -> Bool # (/=) :: IRIRef -> IRIRef -> Bool #
Ord IRIRef Source #
Instance details Defined in Data.RDF.IRI Methods compare :: IRIRef -> IRIRef -> Ordering # (<) :: IRIRef -> IRIRef -> Bool # (<=) :: IRIRef -> IRIRef -> Bool # (>) :: IRIRef -> IRIRef -> Bool # (>=) :: IRIRef -> IRIRef -> Bool # max :: IRIRef -> IRIRef -> IRIRef # min :: IRIRef -> IRIRef -> IRIRef #
Show IRIRef Source #
Instance details Defined in Data.RDF.IRI Methods showsPrec :: Int -> IRIRef -> ShowS # show :: IRIRef -> String # showList :: [IRIRef] -> ShowS #

newtype Scheme Source #

Constructors

Scheme Text

Instances

Instances details

Eq Scheme Source #
Instance details Defined in Data.RDF.IRI Methods (==) :: Scheme -> Scheme -> Bool # (/=) :: Scheme -> Scheme -> Bool #
Ord Scheme Source #
Instance details Defined in Data.RDF.IRI Methods compare :: Scheme -> Scheme -> Ordering # (<) :: Scheme -> Scheme -> Bool # (<=) :: Scheme -> Scheme -> Bool # (>) :: Scheme -> Scheme -> Bool # (>=) :: Scheme -> Scheme -> Bool # max :: Scheme -> Scheme -> Scheme # min :: Scheme -> Scheme -> Scheme #
Show Scheme Source #
Instance details Defined in Data.RDF.IRI Methods showsPrec :: Int -> Scheme -> ShowS # show :: Scheme -> String # showList :: [Scheme] -> ShowS #

data Authority Source #

Constructors

Authority !(Maybe UserInfo) !Host !(Maybe Port)

Instances

Instances details

Eq Authority Source #
Instance details Defined in Data.RDF.IRI Methods (==) :: Authority -> Authority -> Bool # (/=) :: Authority -> Authority -> Bool #
Ord Authority Source #
Instance details Defined in Data.RDF.IRI 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 Data.RDF.IRI Methods showsPrec :: Int -> Authority -> ShowS # show :: Authority -> String # showList :: [Authority] -> ShowS #

newtype UserInfo Source #

Constructors

UserInfo Text

Instances

Instances details

Eq UserInfo Source #
Instance details Defined in Data.RDF.IRI Methods (==) :: UserInfo -> UserInfo -> Bool # (/=) :: UserInfo -> UserInfo -> Bool #
Ord UserInfo Source #
Instance details Defined in Data.RDF.IRI 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 Data.RDF.IRI Methods showsPrec :: Int -> UserInfo -> ShowS # show :: UserInfo -> String # showList :: [UserInfo] -> ShowS #

newtype Host Source #

Constructors

Host Text

Instances

Instances details

Eq Host Source #
Instance details Defined in Data.RDF.IRI Methods (==) :: Host -> Host -> Bool # (/=) :: Host -> Host -> Bool #
Ord Host Source #
Instance details Defined in Data.RDF.IRI Methods compare :: Host -> Host -> Ordering # (<) :: Host -> Host -> Bool # (<=) :: Host -> Host -> Bool # (>) :: Host -> Host -> Bool # (>=) :: Host -> Host -> Bool # max :: Host -> Host -> Host # min :: Host -> Host -> Host #
Show Host Source #
Instance details Defined in Data.RDF.IRI Methods showsPrec :: Int -> Host -> ShowS # show :: Host -> String # showList :: [Host] -> ShowS #

newtype Port Source #

Constructors

Port Int

Instances

Instances details

Eq Port Source #
Instance details Defined in Data.RDF.IRI Methods (==) :: Port -> Port -> Bool # (/=) :: Port -> Port -> Bool #
Ord Port Source #
Instance details Defined in Data.RDF.IRI Methods compare :: Port -> Port -> Ordering # (<) :: Port -> Port -> Bool # (<=) :: Port -> Port -> Bool # (>) :: Port -> Port -> Bool # (>=) :: Port -> Port -> Bool # max :: Port -> Port -> Port # min :: Port -> Port -> Port #
Show Port Source #
Instance details Defined in Data.RDF.IRI Methods showsPrec :: Int -> Port -> ShowS # show :: Port -> String # showList :: [Port] -> ShowS #

newtype Path Source #

Constructors

Path Text

Instances

Instances details

Eq Path Source #
Instance details Defined in Data.RDF.IRI Methods (==) :: Path -> Path -> Bool # (/=) :: Path -> Path -> Bool #
Ord Path Source #
Instance details Defined in Data.RDF.IRI Methods compare :: Path -> Path -> Ordering # (<) :: Path -> Path -> Bool # (<=) :: Path -> Path -> Bool # (>) :: Path -> Path -> Bool # (>=) :: Path -> Path -> Bool # max :: Path -> Path -> Path # min :: Path -> Path -> Path #
Show Path Source #
Instance details Defined in Data.RDF.IRI Methods showsPrec :: Int -> Path -> ShowS # show :: Path -> String # showList :: [Path] -> ShowS #
Semigroup Path Source #
Instance details Defined in Data.RDF.IRI Methods (<>) :: Path -> Path -> Path # sconcat :: NonEmpty Path -> Path # stimes :: Integral b => b -> Path -> Path #
Monoid Path Source #
Instance details Defined in Data.RDF.IRI Methods mempty :: Path # mappend :: Path -> Path -> Path # mconcat :: [Path] -> Path #

newtype IRIQuery Source #

Constructors

IRIQuery Text

Instances

Instances details

Eq IRIQuery Source #
Instance details Defined in Data.RDF.IRI Methods (==) :: IRIQuery -> IRIQuery -> Bool # (/=) :: IRIQuery -> IRIQuery -> Bool #
Ord IRIQuery Source #
Instance details Defined in Data.RDF.IRI Methods compare :: IRIQuery -> IRIQuery -> Ordering # (<) :: IRIQuery -> IRIQuery -> Bool # (<=) :: IRIQuery -> IRIQuery -> Bool # (>) :: IRIQuery -> IRIQuery -> Bool # (>=) :: IRIQuery -> IRIQuery -> Bool # max :: IRIQuery -> IRIQuery -> IRIQuery # min :: IRIQuery -> IRIQuery -> IRIQuery #
Show IRIQuery Source #
Instance details Defined in Data.RDF.IRI Methods showsPrec :: Int -> IRIQuery -> ShowS # show :: IRIQuery -> String # showList :: [IRIQuery] -> ShowS #
Semigroup IRIQuery Source #
Instance details Defined in Data.RDF.IRI Methods (<>) :: IRIQuery -> IRIQuery -> IRIQuery # sconcat :: NonEmpty IRIQuery -> IRIQuery # stimes :: Integral b => b -> IRIQuery -> IRIQuery #
Monoid IRIQuery Source #
Instance details Defined in Data.RDF.IRI Methods mempty :: IRIQuery # mappend :: IRIQuery -> IRIQuery -> IRIQuery # mconcat :: [IRIQuery] -> IRIQuery #

newtype Fragment Source #

Constructors

Fragment Text

Instances

Instances details

Eq Fragment Source #
Instance details Defined in Data.RDF.IRI Methods (==) :: Fragment -> Fragment -> Bool # (/=) :: Fragment -> Fragment -> Bool #
Ord Fragment Source #
Instance details Defined in Data.RDF.IRI Methods compare :: Fragment -> Fragment -> Ordering # (<) :: Fragment -> Fragment -> Bool # (<=) :: Fragment -> Fragment -> Bool # (>) :: Fragment -> Fragment -> Bool # (>=) :: Fragment -> Fragment -> Bool # max :: Fragment -> Fragment -> Fragment # min :: Fragment -> Fragment -> Fragment #
Show Fragment Source #
Instance details Defined in Data.RDF.IRI Methods showsPrec :: Int -> Fragment -> ShowS # show :: Fragment -> String # showList :: [Fragment] -> ShowS #
Semigroup Fragment Source #
Instance details Defined in Data.RDF.IRI Methods (<>) :: Fragment -> Fragment -> Fragment # sconcat :: NonEmpty Fragment -> Fragment # stimes :: Integral b => b -> Fragment -> Fragment #
Monoid Fragment Source #
Instance details Defined in Data.RDF.IRI Methods mempty :: Fragment # mappend :: Fragment -> Fragment -> Fragment # mconcat :: [Fragment] -> Fragment #

data IRIError Source #

Constructors

InvalidIRI

Instances

Instances details

Eq IRIError Source #
Instance details Defined in Data.RDF.IRI Methods (==) :: IRIError -> IRIError -> Bool # (/=) :: IRIError -> IRIError -> Bool #
Show IRIError Source #
Instance details Defined in Data.RDF.IRI Methods showsPrec :: Int -> IRIError -> ShowS # show :: IRIError -> String # showList :: [IRIError] -> ShowS #

data SchemaError Source #

Constructors

NonAlphaLeading	Scheme must start with an alphabet character
InvalidChars	Subsequent characters in the schema were invalid
MissingColon	Schemas must be followed by a colon

Instances

Instances details

Eq SchemaError Source #
Instance details Defined in Data.RDF.IRI Methods (==) :: SchemaError -> SchemaError -> Bool # (/=) :: SchemaError -> SchemaError -> Bool #
Show SchemaError Source #
Instance details Defined in Data.RDF.IRI Methods showsPrec :: Int -> SchemaError -> ShowS # show :: SchemaError -> String # showList :: [SchemaError] -> ShowS #

mkIRI :: Text -> Either String IRI Source #

serializeIRI :: IRIRef -> Text Source #

parseIRI :: Text -> Either String IRIRef Source #

parseRelIRI :: Text -> Either String IRIRef Source #

validateIRI :: Text -> Either String Text Source #

resolveIRI Source #

Arguments

:: Text	Base URI
-> Text	URI to resolve
-> Either String Text

IRI parsing and resolution according to algorithm 5.2 from RFC3986 See: http://www.ietf.org/rfc/rfc3986.txt [FIXME] Currently, this is a correct but naive implementation.

removeIRIFragment :: IRIRef -> IRIRef Source #