nicknamer 0.1.0

A tool for generating alternate names.
Documentation
  • Coverage
  • 50%
    1 out of 2 items documented0 out of 1 items with examples
  • Size
  • Source code size: 95.27 kB This is the summed size of all the files inside the crates.io package for this release.
  • Documentation size: 243.06 kB This is the summed size of all files generated by rustdoc for all configured targets
  • Ø build duration
  • this release: 10s Average build duration of successful builds.
  • all releases: 10s Average build duration of successful builds in releases after 2024-10-23.
  • Links
  • Homepage
  • gravitrnic/nicknamer
    1 0 0
  • crates.io
  • Dependencies
  • Versions
  • Owners
  • gravitrnic

nicknamer

Simple Rust library to get alternate names/nicknames for a given name.

  • Returns only direct alternates (immediate nicknames), not transitive ones.
  • If a name is not found, an empty vector is returned.
  • Input is matched case-insensitively.
  • Output is a Vec<String> of lowercase alternates (does not include the input itself).
  • Data is embedded at compile time from names.csv (no runtime file I/O).

Library Usage

use nicknamer::nicknames;

fn main() {
    let n = nicknames("Abigail");
    // e.g. ["abbe", "abbey", "abbi", "abbie", "abby", "gail", "nabby", ...]
    println!("{:?}", n);
}

CLI Usage

Build and run with a name argument; outputs a comma-separated list of alternates.

cargo run -- "Abigail"

Example output:

abbe,abbey,abbi,abbie,abby,gail,nabby

Data Source

The nickname dataset in names.csv is derived from the carltonnorthern/nicknames project, which is licensed under the Apache License, Version 2.0.

License

This project is dual-licensed under either of:

  • MIT license (see LICENSE-MIT)
  • Apache License, Version 2.0 (see LICENSE-APACHE)

You may choose either license.

Provenance note: Portions of this repository were generated with the help of AI tooling under the direction of the repository maintainer. Review and verify any third‑party data or content included (e.g., names.csv) for suitability in your use case.