cargo_e/
lib.rs

1#![doc = include_str!("../README.md")]
2
3// Re-export std common modules
4pub mod prelude {
5    pub use std::env;
6    pub use std::error::Error;
7    pub use std::fs;
8    pub use std::io;
9    pub use std::path::{Path, PathBuf};
10    pub use std::process::exit;
11    pub use std::process::Child;
12    pub use std::process::Command;
13    pub use std::process::Stdio;
14    pub use std::sync::mpsc;
15    pub use std::sync::{Arc, Mutex};
16    pub use std::time::Instant;
17    pub use tracing::{debug, error, info};
18}
19
20pub mod e_findmain;
21pub use e_findmain::*;
22pub mod e_types;
23pub use e_types::*;
24pub mod e_bacon;
25pub use e_bacon::*;
26pub mod e_cli;
27pub use e_cli::Cli;
28pub mod e_manifest;
29pub use e_manifest::{collect_workspace_members, locate_manifest};
30pub mod e_parser;
31pub use e_parser::parse_available;
32pub mod e_runner;
33pub use e_runner::run_example;
34pub mod e_collect;
35pub mod e_command_builder;
36pub mod e_discovery;
37pub mod e_features;
38pub mod e_target;
39pub mod e_tui;
40
41#[allow(unused_macros)]
42macro_rules! doc_with_joke {
43    (
44        $(#[$attr:meta])*
45        $vis:vis fn $name:ident($($arg:tt)*) -> $ret:ty $body:block
46    ) => {
47        $(#[$attr])*                           // Re-emit external doc attributes.
48        #[doc = "Have you read the Guide for You To Read?"] // Extra injected doc comment.
49        $vis fn $name($($arg)*) -> $ret $body    // Emit the function.
50    };
51}
52
53// Define the helper macro.
54// macro_rules! doc_with_funny {
55//     ($doc:expr) => {
56//         #[doc = concat!($doc, "\n\nSee also the [Guide for You To Read](index.html) for more details.")]
57//     };
58// }
59
60// Define the helper macro that captures external attributes and injects an extra doc attribute.
61// macro_rules! doc_with_funny {
62//     (
63//         $(#[$attr:meta])*
64//         $vis:vis fn $name:ident($($arg:tt)*) -> $ret:ty $body:block
65//     ) => {
66//         $(#[$attr])*                           // Re-emit external doc attributes.
67//         #[doc = "Have you read the Guide for You To Read?"] // Extra injected doc comment.
68//         $vis fn $name($($arg)*) -> $ret $body    // Emit the function.
69//     };
70// }
71
72// #[doc = include_str!("../documents/guide.md")]
73// pub mod a_guide {
74//     /// An example constant to force module inclusion.
75//     doc_with_guide!("This function does something important.");
76//     pub const a_const: () = ();
77
78//     /// An example function to force module inclusion.
79//     pub fn a_function() {}
80
81//     /// An example struct to force module inclusion.
82//     pub struct AStruct;
83
84//     /// An example enum to force module inclusion.
85//     pub enum AEnum {
86//         AVariant,
87//     }
88
89//     /// An example trait to force module inclusion.
90//     pub trait ATrait {}
91
92//     /// An example type alias to force module inclusion.
93//     pub type AType = ();
94// }
95
96// // Re-export so the module shows in the public API.
97// pub use a_guide as __THE_GUIDE;
98
99#[macro_use]
100pub mod a_funny_docs;
101
102#[doc = include_str!("../documents/guide.md")]
103pub mod a_guide {
104    // A constant with a humorous aside
105    #[doc = "A wacky constant that reminds you of the fleeting nature of existence—because constants, like our dreams, never change."]
106    #[doc = "Imagine staring into the abyss of an unchanging value and laughing at the cosmic joke: even when everything is fixed, there’s always room for a little absurdity. In a world of mutable chaos, this constant stands as a monument to the absurdity of permanence."]
107    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON THE MYSTERIES OF CONSTANTS."]
108    pub const A_CONST: () = ();
109    // A function with a humorous aside
110    #[doc = "An eccentric function that performs its task with a whimsical twist."]
111    #[doc = "Picture a function that cracks jokes as it runs—each call a mini stand-up routine where recursion becomes a humorous loop and error handling turns into a comedy of exceptions. This function reminds you that even in logic there is laughter."]
112    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON THE ART OF FUNCTIONAL HUMOR."]
113    pub fn a_function() {}
114
115    // A struct with a humorous aside
116    #[doc = "A delightfully absurd struct that encapsulates the essence of lighthearted programming."]
117    #[doc = "Think of it as the punchline to a well-crafted joke: simple on the surface yet bursting with hidden layers of wit. This struct is the blueprint for designing data structures that know how to have a good time even when they’re being strictly typed."]
118    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON STRUCTURING YOUR HUMOR."]
119    pub struct AStruct;
120
121    // An enum with a humorous aside
122    #[doc = "An enum whose variants are as unpredictable as the punchline of an offbeat comedy routine."]
123    #[doc = "Each variant is a different flavor of chaos—a reminder that sometimes, even in the binary world of enums, you need a twist of fate and a pinch of absurdity. Embrace the randomness with a hearty chuckle."]
124    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON ENUMERATING THE LAUGHTER."]
125    //#[doc = doc_with_funny!("**ENUMERATE THE LAUGHTER:** This enum's variants are as surprising as a punchline in the middle of a monologue. Discover the unexpected twist in every variant.")]
126    pub enum AEnum {
127        #[doc = "A variant that boldly goes where no variant has gone before—capturing the essence of unexpected hilarity."]
128        AVariant,
129    }
130
131    // A trait with a humorous aside
132    #[doc = "A quirky trait that defines behaviors with a tongue-in-cheek twist."]
133    #[doc = "Imagine a trait written by a stand-up comedian: each method is a punchline, each implementation an opportunity for subtle humor. Types implementing this trait are expected not just to act, but to entertain—blending functionality with a dash of wit."]
134    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON TRAIT-ORIENTED COMEDY."]
135    pub trait ATrait {}
136
137    // A type alias with a humorous aside
138    #[doc = "A type alias that serves as a humorous shortcut to a more verbose reality."]
139    #[doc = "Sometimes types need nicknames too. This alias is like that clever one-liner you whisper at a party—short, memorable, and unexpectedly delightful. It’s the wink in the midst of an otherwise serious type system."]
140    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON ALIASING THE ORDINARY INTO THE EXTRAORDINARY."]
141    pub type AType = ();
142}
143
144/// If you didn't get it the first time, then look again!  
145/// Check out the **[GUIDE FOR YOU TO READ](theSeachIsOver/index.html)** for all the brilliant details you missed.
146pub use a_guide as theSeachIsOver;
cargo_e/lib.rs

cargo_e/
lib.rs
