https://github.com/lo48576/iri-string

String types for URIs/IRIs.
https://github.com/lo48576/iri-string

rust

Last synced: 7 months ago
JSON representation

String types for URIs/IRIs.

• Host: GitHub
• URL: https://github.com/lo48576/iri-string
• Owner: lo48576
• License: apache-2.0
• Created: 2018-05-04T10:44:33.000Z (about 8 years ago)
• Default Branch: develop
• Last Pushed: 2025-11-04T16:31:48.000Z (8 months ago)
• Last Synced: 2025-11-04T18:21:13.657Z (8 months ago)
• Topics: rust
• Language: Rust
• Homepage:
• Size: 1020 KB
• Stars: 22
• Watchers: 3
• Forks: 4
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE.txt

Awesome Lists containing this project

README

          
# iri-string

[![Latest version](https://img.shields.io/crates/v/iri-string.svg)](https://crates.io/crates/iri-string)

[![Documentation](https://docs.rs/iri-string/badge.svg)](https://docs.rs/iri-string)

![Minimum rustc version: 1.60](https://img.shields.io/badge/rustc-1.60+-lightgray.svg)

String types for [IRI](https://tools.ietf.org/html/rfc3987)s (Internationalized Resource

Identifiers) and [URI](https://tools.ietf.org/html/rfc3986)s (Uniform Resource Identifiers).

See the [documentation](https://docs.rs/iri-string) for details.

## Features

* `no_std` support.

* String types (both owned and borrowed) for RFC 3986 URIs and RFC 3987 IRIs.

    + Native slice types, so highly operable with `Cow`, `ToOwned`, etc.

    + URIs/IRIs validation.

    + Conversions between URIs and IRIs.

    + Decomposition into components.

* IRI reference resolution algorithm.

* IRI normalization algorithm.

* Masking password part of an IRI (optional and not automatic).

* Percent encoding of user-provided strings.

* IRI builder.

* RFC 6570 URI Template.

### Feature flags

#### Direct

* `alloc` (enabled by default)

    + Enables types and functions which require memory allocation.

    + Requires `std` or `alloc` crate available.

* `std` (enabled by default)

    + Enables all `std` features (such as memory allocations and `std::error::Error` trait).

    + Requires `std` crate available.

    + This automatically enables `alloc` feature.

#### memchr

* `memchr`

    + Enables optimization for internal parsers, using [`memchr`] crate.

[`memchr`]: https://crates.io/crates/memchr

#### serde

* `serde`

    + Implements `Serialize` and `Deserialize` traits for string types.

## CI

CI must pass on `develop` and `master` branches.

No automated online CI is set up (since they consumes credit too fast), so run

`cargo make manual-ci-all` locally before committing to these branches.

On other branches, tests and some lints (such as `dead_code`) are allowed to

fail, but all commits must be successfully compilable and must be formatted.

## License

Licensed under either of

* Apache License, Version 2.0, ([LICENSE-APACHE.txt](LICENSE-APACHE.txt) or

  )

* MIT license ([LICENSE-MIT.txt](LICENSE-MIT.txt) or

  )

at your option.

### Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted

for inclusion in the work by you, as defined in the Apache-2.0 license, shall be

dual licensed as above, without any additional terms or conditions.