feat: add no-std support (#42)

* feat: add no-std support

* docs: update metadata

* fix: implement no-std properly

* chore: custom test script

* ci: fix

* docs: reference related issue

* ci: rename a step

* refactor: remove unused code

* test: serde

* docs: remove incorrect feature

* docs: features

* docs: remove unnecessary `mut`

* docs: correct the comment

* fix: replace alloc with std

* fix: clippy should error on warnings

* ci: use cargo-hack

* test: libcpp

* chore: allow users of test.sh to skip features

* docs: libcpp

* docs: test.sh

---------

Co-authored-by: Yagiz Nizipli <[email protected]>

Author: KSXGitHub

.github/workflows/ci.yml

@@ -49,16 +49,19 @@ jobs:
 
       - run: rustup show
 
-      - name: Cargo Check
-        run: cargo check --all-targets --all-features --locked
+      - name: Install cargo-hack
+        uses: taiki-e/install-action@cargo-hack
 
-      - name: Cargo Test
-        run: cargo test --all-targets --all-features
+      - name: Clippy
+        run: cargo hack clippy --feature-powerset -- -D warnings
 
-      - name: Cargo Doc
+      - name: Test
+        run: cargo hack test --feature-powerset
+
+      - name: Check Documentation
         env:
           RUSTDOCFLAGS: '-D warnings'
-        run: cargo doc
+        run: cargo hack doc --feature-powerset
 
   format:
     name: Format

Cargo.lock

@@ -12,8 +12,9 @@ description = "Fast WHATWG Compliant URL parser"
 documentation = "https://docs.rs/ada-url"
 readme = "README.md"
 keywords = ["url", "parser", "whatwg", "performance"]
-categories = ["parser-implementations", "web-programming", "encoding"]
-repository = "https://ada-url.com"
+categories = ["parser-implementations", "web-programming", "encoding", "parsing", "no-std::no-alloc", "no-std"]
+repository = "https://github.com/ada-url/rust"
+homepage = "https://ada-url.com"
 license = "MIT OR Apache-2.0"
 
 [[bench]]
@@ -22,10 +23,13 @@ path = "bench/parse.rs"
 harness = false
 
 [features]
+default = ["std"]
 # pass `cpp_set_stdlib("c++")` to `cc`
 libcpp = []
 # enables serde serialization/deserialization support
-serde = ["dep:serde"]
+serde = ["dep:serde", "std"]
+# enable allocations
+std = []
 
 [dependencies]
 derive_more = "0.99.17"

Cargo.toml

@@ -9,7 +9,7 @@ Here is an example illustrating a common usage:
 ```Rust
 use ada_url::Url;
 fn main() {
-    let mut u = Url::parse("http://www.google:8080/love#drug", None).expect("bad url");
+    let u = Url::parse("http://www.google:8080/love#drug", None).expect("bad url");
     println!("port: {:?}", u.port());
     println!("hash: {:?}", u.hash());
     println!("pathname: {:?}", u.pathname());
@@ -19,6 +19,14 @@ fn main() {
 }
 ```
 
+#### Features
+
+**std:** Functionalities that require `std`. This feature is enabled by default, set `no-default-features` to `true` if you want `no-std`.
+
+**serde:** Allow `Url` to work with `serde`. This feature is disabled by default. Enabling this feature without `std` would provide you only `Serialize`. Enabling this feature and `std` would provide you both `Serialize` and `Deserialize`.
+
+**libcpp:** Build `ada-url` with `libc++`. This feature is disabled by default. Enabling this feature without `libc++` installed would cause compile error.
+
 ### Performance
 
 Ada is fast. The benchmark below shows **3.34 times** faster URL parsing compared to `url`
@@ -48,3 +56,21 @@ parse/url               time:   [6.9266 µs 6.9677 µs 7.0199 µs]
 | **[`Deref<Target=str>`](https://doc.rust-lang.org/std/ops/trait.Deref.html)**                                                                         | Allows for `&Url` to dereference as a `&str`. Also provides a [number of string methods](https://doc.rust-lang.org/std/string/struct.String.html#deref-methods-str)                                           |
 | **[`AsRef<[u8]>`](https://doc.rust-lang.org/std/convert/trait.AsRef.html), [`AsRef<str>`](https://doc.rust-lang.org/std/convert/trait.AsRef.html)**   | Used to do a cheap reference-to-reference conversion.                                                                                                                                                         |
 | **[`Send`](https://doc.rust-lang.org/std/marker/trait.Send.html)**                                                                                    | Used to declare that the type can be transferred across thread boundaries.                                                                                                                                    |
+
+### Development
+
+#### `test.sh`
+
+`test.sh` is a convenient helper script that would allow developer to quickly and comprehensively check, lint, and test their code and documentation.
+
+**Basic Usage:**
+
+```sh
+./test.sh
+```
+
+**Skipping features:**
+
+```sh
+SKIP_FEATURES=serde,libcpp ./test.sh
+```

README.md

@@ -20,7 +20,7 @@ pub fn parse_benchmark(c: &mut Criterion) {
     group.bench_function("ada_url", |b| {
         b.iter(|| {
             URLS.iter().for_each(|url| {
-                black_box(url).parse::<ada_url::Url>().unwrap();
+                ada_url::Url::try_from(*black_box(url)).unwrap();
             })
         })
     });