generate

Function generate 

Source
pub fn generate(options: GenerateOptions) -> Result<String, MemorableIdError>
Expand description

Generate a memorable ID

§Arguments

  • options - Configuration options

§Returns

Generated memorable ID

§Examples

use memorable_ids::{generate, GenerateOptions, suffix_generators};

// Default: 2 components, no suffix
let id = generate(GenerateOptions::default()).unwrap();
// Example: "cute-rabbit"

// 3 components
let id = generate(GenerateOptions {
    components: 3,
    ..Default::default()
}).unwrap();
// Example: "large-fox-swim"

// With numeric suffix
let id = generate(GenerateOptions {
    components: 2,
    suffix: Some(suffix_generators::number),
    ..Default::default()
}).unwrap();
// Example: "quick-mouse-042"

// Custom separator
let id = generate(GenerateOptions {
    components: 2,
    separator: "_".to_string(),
    ..Default::default()
}).unwrap();
// Example: "warm_duck"