wikidot-path

Simple library to provide Wikidot-compatible path parsing

14 releases (6 breaking)

0.6.0 Sep 29, 2023
0.5.1 Apr 24, 2023
0.4.1 Apr 17, 2023
0.2.4 Sep 9, 2021
0.1.0 Jan 26, 2020
Download history 14/week @ 2024-06-13 21/week @ 2024-06-20 87/week @ 2024-06-27 54/week @ 2024-07-04 51/week @ 2024-07-11 12/week @ 2024-07-18 29/week @ 2024-07-25 70/week @ 2024-08-01 21/week @ 2024-08-08 31/week @ 2024-08-15 14/week @ 2024-08-22 58/week @ 2024-08-29 83/week @ 2024-09-05 36/week @ 2024-09-12 58/week @ 2024-09-19 55/week @ 2024-09-26

250 downloads per month
Used in 2 crates (via deepwell)

MIT license

15KB
216 lines

wikidot-path

Rust CI badge docs.rs link

Simple library to provide Wikidot-compatible path parsing.

Wikidot accepts paths in an unusual manner: each argument is submitted as another "directory".

For instance, to access page scp-xxxx with options norender and edit, you would go to /scp-xxxx/norender/true/edit/true.

However this also extends its usage in a few minor ways. For instance, options like edit only make sense when true, but passing that field is always required by Wikidot. Thus the logical URL /scp-xxxx/edit doesn't work, despite it being rather clear to a human what the intent is. This library adjusts this by allowing "solo keys" (those without values).

Additionally URL normalization is performed. See the wikidot-normalize crate for more information.

Available under the terms of the MIT License. See LICENSE.md.

Compilation

This library targets the latest stable Rust. At time of writing, that is 1.68.2

$ cargo build --release

Testing

$ cargo test

Add -- --nocapture to the end if you want to see test output.

Dependencies

~3–4MB
~86K SLoC