Skip to content

Latest commit

 

History

History
82 lines (55 loc) · 2.77 KB

README.md

File metadata and controls

82 lines (55 loc) · 2.77 KB

URIParser.jl

This Julia package provides URI parsing according to RFC 3986.

This package is deprecated. Please open new issues in URIs.jl.

Build Status codecov.io

URIParser URIParser

The main interaction with the package is through the URI constructor, which takes a string argument, e.g.

julia> using URIParser

julia> URI("hdfs://user:password@hdfshost:9000/root/folder/file.csv")
URI(hdfs://user:password@hdfshost:9000/root/folder/file.csv)

julia> URI("https://user:password@httphost:9000/path1/path2;paramstring?q=a&p=r#frag")
URI(https://user:password@httphost:9000/path1/path2;paramstring?q=a&p=r#frag)

julia> URI("news:comp.infosystems.www.servers.unix")
URI(news:comp.infosystems.www.servers.unix)

Additionally, there is a method for taking the parts of the URI individually, as well as a convenience method taking host and path which constructs a valid HTTP URL:

julia> URI("hdfs","hdfshost",9000,"/root/folder/file.csv","","","user:password")
URI(hdfs://user:password@hdfshost:9000/root/folder/file.csv)

julia> URI("google.com","/some/path")
URI(http://google.com:80/some/path)

Afterwards, you may either pass the API struct directly to another package (probably the more common use case) or extract parts of the URI as follows:

julia> uri = URI("https://user:password@httphost:9000/path1/path2;paramstring?q=a&p=r#frag")
URI(https://user:password@httphost:9000/path1/path2;paramstring?q=a&p=r#frag)

julia> uri.scheme
"https"

julia> uri.host
"httphost"

julia> dec(uri.port)
"9000"

julia> uri.path
"/path1/path2;paramstring"

julia> uri.query
"q=a&p=r"

julia> uri.fragment
"frag"

julia> uri.specifies_authority
true

The specifies_authority may need some extra explanation. The reson for its existence is that RFC 3986 differentiates between empty authorities and missing authorities, but there is not way to distinguish these by just looking at the fields. As an example:

julia> URI("file:///a/b/c").specifies_authority
true

julia> URI("file:///a/b/c").host
""

julia> URI("file:a/b/c").specifies_authority
false

julia> URI("file:a/b/c").host
""

Now, while the file scheme consideres these to be equivalent, this may not necessarily be true for all schemes and thus the distinction is necessary.