mock_rs/
lib.rs

1//! # mock-rs
2//! A Rust crate to generate fake data inspired by FakerPHP.(Not Stable yet).
3//! 
4//! ## Structure
5//! The crate is divided into providers. A provider is a module that represents a particular locale. A provider contains sub-providers for that particular locale The available locales right now are: `en_us` and `universal`. Many more are going to be added in the future.
6//! 
7//! ## Examples
8//! ### `en_us` Person provider
9//! ```rust
10//! use mock_rs::{en_us::Person, PersonTrait, Gender};
11//! 
12//! // Initialize `en_us` person
13//! let en_us_person = Person::new(); 
14//! 
15//! // Get random en_us male_name
16//! let male_name = en_us_person.name(Some(Gender::Male));
17//! println!("{}", male_name);
18//! 
19//! //Get random en_us female_name
20//! let female_male_name = en_us_person.name(Some(Gender::Female));
21//! println!("{}", female_male_name);
22//! 
23//! ```
24
25mod calculator;
26mod helpers;
27
28pub mod provider;
29
30pub use provider::en_us;
31pub use provider::universal::{barcode::Barcode, color::Color, payment::Payment};
32
33pub use provider::{
34    address::AddressTrait,
35    company::CompanyTrait,
36    payment::PaymentTrait,
37    person::{Gender, PersonTrait},
38    phone_number::PhoneNumberTrait,
39};