Faker-Rust

Quick links

• 📖 Read the documentation
• 📢 See what's changed in recent versions

Table of Contents

• Faker-Rust
  • Quick links
  • Features
  • Getting Started
  • Usage
  • Generators
  • Notes
  • Deterministic Random
  • Localization
  • Contributing
  • Inspiration
  • License

Features

• 🚀 High Performance: Built in Rust for blazing-fast data generation
• 🌍 Locale-Aware: Multi-language support with fallback mechanism
• 🎲 Reproducible: Seedable RNG for deterministic data generation
• 📦 Complete Parity: 100% API compatibility with Ruby Faker gem
• 🧪 Well Tested: 549+ unit tests ensuring reliability
• 🏢 100+ Modules: Internet, Person, Location, Finance, and much more

Getting Started

Add this to your Cargo.toml:

[dependencies]
faker-rust = "0.1.0"

Then run cargo build.

Usage

use faker_rust::name;
use faker_rust::internet;
use faker_rust::address;
use faker_rust::lorem;
use faker_rust::programming_language;

fn main() {
    // Person
    println!("{}", name::name());                      //=> "Christophe Bartell"
    
    // Internet
    println!("{}", internet::password());            //=> "Vg5mSvY1UeRg7"
    println!("{}", internet::email(None, None, None)); //=> "eliza@mann.test"
    
    // Address
    println!("{}", address::full_address());         //=> "5479 William Way, East Sonnyhaven, LA 63637"
    
    // Lorem
    println!("{}", lorem::paragraph());                //=> "Recusandae minima consequatur. Expedita sequi blanditiis. Ut fuga et."
    
    // Programming Language
    println!("{}", programming_language::name());      //=> "Rust"
    
    // Seeded Randomness for Reproducibility
    faker_rust::Faker::set_seed(12345);
    println!("Seeded: {}", name::name());             // Always returns same value
}

🖥️ Command Line Interface (CLI)

Faker-Rust now includes a powerful CLI tool for generating fake data directly from the command line:

Installation

cargo install faker-rust

Or run directly with:

# Run the CLI binary
cargo run --bin faker-rust -- name

# Run from installed binary
faker-rust name

Quick CLI Examples

# Generate a random name
faker-rust name

# Or using cargo run
cargo run --bin faker-rust -- name

# Generate an email
faker-rust email

# Generate multiple values
faker-rust -c 5 name

# Generate deterministic output (repeatable)
faker-rust --seed 12345 name

# List all available generators
faker-rust list

CLI Demo Example

Run the interactive CLI demo example:

cargo run --example cli_demo

CLI Commands

For complete CLI documentation, see CLI.md.

Generators

To see the full list, check out the GENERATORS document.

Default Generators

Entertainment Generators

Specialty Generators

Regional & Tech Generators

Notes

• While Faker generates data at random, returned values are not guaranteed to be unique by default.
• Values can be deterministic if you use the seeded RNG feature.
• This is the main branch and may contain unreleased changes. See CHANGELOG for all versions.

Deterministic Random

Faker supports seeding of its pseudo-random number generator to provide deterministic output:

use faker_rust::Faker;
use faker_rust::name;

fn main() {
    Faker::set_seed(42);
    println!("{}", name::name());  //=> "Aurelia Wilkinson"
    
    Faker::set_seed(42);
    println!("{}", name::name());  //=> "Aurelia Wilkinson" (same value)
}

Localization

Faker supports locale-aware data generation:

// Set locale for data generation
faker_rust::locale::set_locale("en");

// The library will use locale-specific data where available,
// falling back to English defaults for missing translations

Contributing

Contributions are welcome! Feel free to open issues and pull requests.

Inspiration

Faker-Rust is inspired by the legendary Ruby Faker gem and aims to bring the same ease of use and comprehensive coverage to the Rust ecosystem.

License

This code is free to use under the terms of the MIT license.

MIT License

Links

https://github.com/faker-rust/faker-rust

https://github.com/faker-rust/faker-rust/issues

https://github.com/faker-rust/faker-rust/discussions

https://github.com/faker-rust/faker-rust/pulls

https://github.com/faker-rust/faker-rust/wiki

https://github.com/faker-rust/faker-rust/blob/main/SECURITY.md

https://github.com/faker-rust/faker-rust/blob/main/CONTRIBUTING.md

https://github.com/faker-rust/faker-rust/blob/main/CODE_OF_CONDUCT.md

https://gilcierweb.com.br