aboutsummaryrefslogtreecommitdiff
path: root/README.md
blob: 64114f445c42d1c7b24c925041f813e550334e6e (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
# Uri

This is a library which implements [IETF RFC
3986](https://tools.ietf.org/html/rfc3986), "Uniform Resource Identifier (URI):
Generic Syntax".

More information about this library can be found in
the [crate documentation](https://docs.rs/uris).

A URI is a compact sequence of characters that identifies an abstract or
physical resource.  One common form of URI is the Uniform Resource Locator
(URL), used to reference web resources:

    http://www.example.com/foo?bar#baz

Another kind of URI is the path reference:

    /usr/bin/zip

The purpose of this library is to provide a `Uri` type to represent a URI,
with functions to parse URIs from their string representations, as well as
assemble URIs from their various components.

## Credits

This library has been forked from [rhymuri](https://crates.io/crates/rhymuri)
because it was unmaintained at the time.
Thanks to Richard Walters for the original implementation!

## License

Licensed under the [MIT license](LICENSE.txt).