Skip to main content

Crate joyful

Crate joyful 

Source
Expand description

§Joyful

Generate delightful, random word combinations.

This library creates memorable, pronounceable strings by combining a prefix with random words from curated word lists. Perfect for generating friendly names, identifiers, or random text that’s easy to read and remember.

§Quick Start

use joyful::{joyful, Options};

// Generate with default options (2 segments, dash separator)
let name = joyful(Options::default()).unwrap();
println!("{}", name); // e.g., "happy-mountain"

// Customize the output
let custom = joyful(Options {
    segments: 3,
    separator: '_',
    max_length: Some(20),
}).unwrap();
println!("{}", custom); // e.g., "cool_river_sky"

§Features

  • Configurable number of word segments
  • Custom separators
  • Optional maximum length constraints
  • Guaranteed word uniqueness within each generated string
  • Always starts with a memorable prefix word

Modules§

errors
Error types for the joyful library.
words
Word lists and categories used for generation.

Structs§

Options
Configuration options for generating word combinations.

Functions§

joyful
Generates a random, delightful word combination.