use-id-slug 0.0.1

Composable human-readable slug primitives for RustUse
Documentation 
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
33
34
35
36
37
38
39
40
41
42

# use-id-slug

Human-readable slug normalization and validation helpers for `RustUse`.

## Install

```toml
[dependencies]
use-id-slug = "0.0.1"
```

The published package keeps the Rust crate name `use_slug`, so code imports stay the same.

## Foundation

`use-id-slug` keeps slug behavior explicit and predictable: normalize free-form text into lowercase ASCII segments joined by hyphens, then validate the canonical form.

## Example

```rust
use use_slug::Slug;

let slug = Slug::new("RustUse Docs")?;

assert_eq!(slug.as_str(), "rustuse-docs");
assert_eq!(slug.segments().collect::<Vec<_>>(), vec!["rustuse", "docs"]);
# Ok::<(), use_slug::SlugError>(())
```

## When to use directly

Choose `use-id-slug` when human-readable identifiers are the only ID surface you need.

## Scope

- Slugs stay lowercase, ASCII, and hyphen-delimited.
- Normalization is deterministic and documented.
- Locale-aware transliteration and routing concerns are out of scope.

## Status

`use-id-slug` is a pre-1.0 crate with a deliberately narrow API.