2 releases
0.1.1 | Feb 24, 2022 |
---|---|
0.1.0 | Feb 19, 2022 |
#10 in #generates-random
42KB
322 lines
name_maker
Generates name for a random person, a group of people, or a family.
What's new with Version 0.1.1
Added command-line support.
Install
Add the following line below the Dependency section in your Cargo.toml file:
name_maker = "0.1.1"
Usage
use name_maker::RandomNameGenerator;
use name_maker::Gender;
let rng = RandomNameGenerator::init();
// Prints a random name composed of first name and last name.
println!("{}", rng.generate());
// Prints a random name with a masculine first name.
println!("{}", rng.generate_specific(Gender::Male));
// Returns a vector with 5 random names.
let random_names = rng.generate_many(5);
// Returns a vector with 5 random names with feminine first names.
let random_girls = rng.generate_many_specific(0, 5);
// Returns a vector with 5 random names with similar last name.
// The first and second element are the "parents" and the succeeding
// elements are their "children".
let family = rng.generate_family(3);
// It is also possible to specify the number of male and female children
// in the family. In this example, the family have 5 boys and 1 girl.
let good_luck_courting_her = rng.generate_family_specific(5, 1);
For more info, visit the official API documentation.
Command-line Support
All the library's functionalities can be called directly from the command-line. Just
install its binary executable using cargo install name_maker
, and run name_maker -h
to see the different options for executing the command:
USAGE:
name_maker -h|--help
name_maker [amount]
name_maker -m|--male|-f|--female [amount]
name_maker -M|--many|-F|--family [amount|male_amount female_amount]
Credits
- First name data (both male and female) from Mark Kantrowitz.
- Last name data from smashew's NameDatabases.
Dependencies
~305KB