Crate human_friendly_ids

Human Friendly Ids

This Rust library is used for generating random human-friendly ids with a base-23 character set. The ids are generated using a cryptographically secure random number generator.

The primary reason you would use this library is to generate visually unambiguous ids that are easy to read, write, and speak over the phone. The library automatically corrects for common visual confusions such as 1 vs l, 0 vs O, and 5 vs S, rn vs m, etc.

There is some excellent prior art in this space such as:

• https://gajus.com/blog/avoiding-visually-ambiguous-characters-in-ids
• https://www.crockford.com/base32.html
• https://github.com/google/open-location-code

Note that this library makes no attempt to avoid creating offensive or inappropriate ids. If you need to avoid generating such ids, you should filter them out after generating them.

Getting Started

[dependencies]
human_friendly_ids = "0.1.0"

Usage

use human_friendly_ids::{UploadId, UploadIdDist};
use rand::{Rng, distr::Distribution, thread_rng};

let mut rng = thread_rng();
let dist = UploadIdDist::<12>;

let id = dist.sample(&mut rng);
println!("Generated ID: {}", id);

Contribution

If you would like to contribute to this project, please open an issue or a pull request.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Please observer the Unicode-3.0 license for the relevant code included in this library.

Re-exports

pub use distribution::UploadIdDist;

pub use crate::id::UploadId;

Modules

alphabet

Character handling and validation for user-friendly IDs

distribution

Random generation of user-friendly IDs

error

Error types for user-friendly ID operations

id

Core ID type and associated operations