Skip to main content

mockd/
lib.rs

1#![allow(dead_code)]
2#![cfg_attr(docsrs, feature(doc_cfg))]
3#![warn(missing_docs)]
4#![cfg_attr(docsrs, feature(rustdoc_missing_doc_code_examples))]
5// #![cfg_attr(docsrs, warn(rustdoc::missing_doc_code_examples))]
6#![cfg_attr(docsrs, warn(rustdoc::invalid_codeblock_attributes))]
7
8//! mockd
9//!
10//! # Build the request and verify
11//!
12//! Provide mock data that conforms to the expected format as test inputs.
13//!
14//! Providing randomly generated data is a best practice.
15//!
16//! ## Examples
17//!
18//! ### Using default features
19//!
20//! ```rust
21//! use mockd::file;
22//!
23//!     let data = file::mime_type(); // mime_type: text/x-fortran
24//!     let data = file::extension(); // extension: aspx
25//! ```
26//!
27//! ### Using image feature
28//!
29//! ```toml
30//! [dependencies]
31//! mockd = "0.5.3"
32//! ```
33//!
34//! ```no_compile
35//! use mockd::image;
36//!
37//!     let data = image::url(500, 500); // url: https://picsum.photos/500/500
38//! ```
39//!
40//! # Features
41//!
42//! To access the related generators the feature must be enabled. The following
43//! features are available:
44//! * default - includes file feature only
45//! * all - Enables all features
46//! * address
47//! * animal
48//! * beer
49//! * company
50//! * contact
51//! * currency
52//! * datetime
53//! * file
54//! * generator
55//! * hacker
56//! * hipster
57//! * image
58//! * internet
59//! * job
60//! * language
61//! * log-level
62//! * name
63//! * password
64//! * payment
65//! * person
66//! * random-bool
67//! * status-code
68//! * unique
69//! * user-agent
70//! * vehicle
71//! * words
72//!
73
74#[cfg(feature = "address")]
75pub mod address;
76#[cfg(feature = "animal")]
77pub mod animal;
78#[cfg(feature = "beer")]
79pub mod beer;
80#[cfg(feature = "random-bool")]
81pub mod bool_rand;
82#[cfg(feature = "colour")]
83pub mod colour;
84#[cfg(feature = "company")]
85pub mod company;
86#[cfg(feature = "contact")]
87pub mod contact;
88#[cfg(feature = "currency")]
89pub mod currency;
90#[cfg(feature = "datetime")]
91pub mod datetime;
92#[cfg(feature = "file")]
93pub mod file;
94#[cfg(feature = "generator")]
95pub mod generator;
96#[cfg(feature = "hacker")]
97pub mod hacker;
98#[cfg(feature = "hipster")]
99pub mod hipster;
100#[cfg(feature = "image")]
101pub mod image;
102#[cfg(feature = "internet")]
103pub mod internet;
104#[cfg(feature = "job")]
105pub mod job;
106#[cfg(feature = "language")]
107pub mod language;
108#[cfg(feature = "log-level")]
109pub mod log_level;
110#[cfg(feature = "misc")]
111pub(crate) mod misc;
112#[cfg(feature = "name")]
113pub mod name;
114#[cfg(feature = "password")]
115pub mod password;
116#[cfg(feature = "payment")]
117pub mod payment;
118#[cfg(feature = "person")]
119pub mod person;
120#[cfg(feature = "status-code")]
121pub mod status_code;
122#[cfg(feature = "unique")]
123pub mod unique;
124#[cfg(feature = "user-agent")]
125pub mod user_agent;
126#[cfg(feature = "vehicle")]
127pub mod vehicle;
128#[cfg(feature = "words")]
129pub mod words;
130
131#[cfg(test)]
132pub(crate) mod testify;