fluent-uri

A generic URI/IRI handling library compliant with RFC 3986 and RFC 3987. It is:

• Fast: Zero-copy parsing. Benchmarked to be highly performant.[^bench-res]
• Easy: Carefully designed and documented APIs. Handy percent-encoding utilities.
• Correct: Forbids unsafe code. Extensively fuzz-tested against other implementations.

Documentation | Discussions

[^bench-res]: In a benchmark on an Intel Core i5-11300H processor, fluent-uri parsed a 61-byte IRI in ~85ns compared to ~125ns for iref, iri-string, and oxiri.

Terminology

A URI reference is either a URI or a relative reference. If it starts with a scheme (like http, ftp, mailto, etc.) followed by a colon (:), it is a URI. For example, http://example.com/ and mailto:user@example.com are URIs. Otherwise, it is a relative reference. For example, //example.org/, /index.html, ../, foo, ?bar, and #baz are relative references.

An IRI (reference) is an internationalized version of URI (reference) which may contain non-ASCII characters.

Examples

• Parse and extract components from a URI:

  const SCHEME_FOO: &Scheme = Scheme::new_or_panic("foo");
  
  let s = "foo://user@example.com:8042/over/there?name=ferret#nose";
  let uri = Uri::parse(s)?;
  
  assert_eq!(uri.scheme(), SCHEME_FOO);
  
  let auth = uri.authority().unwrap();
  assert_eq!(auth.as_str(), "user@example.com:8042");
  assert_eq!(auth.userinfo().unwrap(), "user");
  assert_eq!(auth.host(), "example.com");
  assert!(matches!(auth.host_parsed(), Host::RegName(name) if name == "example.com"));
  assert_eq!(auth.port().unwrap(), "8042");
  assert_eq!(auth.port_to_u16(), Ok(Some(8042)));
  
  assert_eq!(uri.path(), "/over/there");
  assert_eq!(uri.query().unwrap(), "name=ferret");
  assert_eq!(uri.fragment().unwrap(), "nose");
  

• Build a URI using the builder pattern:

  const SCHEME_FOO: &Scheme = Scheme::new_or_panic("foo");
  
  let uri = Uri::builder()
      .scheme(SCHEME_FOO)
      .authority_with(|b| {
          b.userinfo(EStr::new_or_panic("user"))
              .host(EStr::new_or_panic("example.com"))
              .port(8042)
      })
      .path(EStr::new_or_panic("/over/there"))
      .query(EStr::new_or_panic("name=ferret"))
      .fragment(EStr::new_or_panic("nose"))
      .build()
      .unwrap();
  
  assert_eq!(
      uri.as_str(),
      "foo://user@example.com:8042/over/there?name=ferret#nose"
  );
  

• Resolve a URI reference against a base URI:

  let base = Uri::parse("http://example.com/foo/bar")?;
  
  let uri_ref = UriRef::parse("baz")?;
  assert_eq!(uri_ref.resolve_against(&base).unwrap(), "http://example.com/foo/baz");
  
  let uri_ref = UriRef::parse("../baz")?;
  assert_eq!(uri_ref.resolve_against(&base).unwrap(), "http://example.com/baz");
  
  let uri_ref = UriRef::parse("?baz")?;
  assert_eq!(uri_ref.resolve_against(&base).unwrap(), "http://example.com/foo/bar?baz");
  

• Normalize a URI:

  let uri = Uri::parse("eXAMPLE://a/./b/../b/%63/%7bfoo%7d")?;
  assert_eq!(uri.normalize(), "example://a/b/c/%7Bfoo%7D");
  

• EStr (Percent-encoded string slices):

  All components in a URI that may be percent-encoded are parsed as EStrs, which allows easy splitting and decoding:

  let s = "?name=%E5%BC%A0%E4%B8%89&speech=%C2%A1Ol%C3%A9%21";
  let query = UriRef::parse(s).unwrap().query().unwrap();
  let map: HashMap<_, _> = query
      .split('&')
      .map(|s| s.split_once('=').unwrap_or((s, EStr::EMPTY)))
      .map(|(k, v)| (k.decode().into_string_lossy(), v.decode().into_string_lossy()))
      .collect();
  assert_eq!(map["name"], "张三");
  assert_eq!(map["speech"], "¡Olé!");
  

• EString (A percent-encoded, growable string):

  You can encode key-value pairs to a query string and use it to build a URI reference:

  let pairs = [("name", "张三"), ("speech", "¡Olé!")];
  let mut buf = EString::<Query>::new();
  for (k, v) in pairs {
      if !buf.is_empty() {
          buf.push_byte(b'&');
      }
      buf.encode::<Data>(k);
      buf.push_byte(b'=');
      buf.encode::<Data>(v);
  }
  
  assert_eq!(buf, "name=%E5%BC%A0%E4%B8%89&speech=%C2%A1Ol%C3%A9%21");
  
  let uri_ref = UriRef::builder()
      .path(EStr::EMPTY)
      .query(&buf)
      .build()
      .unwrap();
  assert_eq!(uri_ref.as_str(), "?name=%E5%BC%A0%E4%B8%89&speech=%C2%A1Ol%C3%A9%21");