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    pub use log::{debug, error, info, log_enabled, Level};
19}
20
21pub mod e_findmain;
22pub use e_findmain::*;
23pub mod e_types;
24pub use e_types::*;
25pub mod e_bacon;
26pub use e_bacon::*;
27pub mod e_cli;
28pub use e_cli::Cli;
29pub mod e_manifest;
30pub use e_manifest::{collect_workspace_members, locate_manifest};
31pub mod e_parser;
32pub use e_parser::parse_available;
33pub mod e_runner;
34pub use e_runner::run_example;
35pub mod e_collect;
36pub mod e_command_builder;
37pub mod e_discovery;
38pub mod e_features;
39pub mod e_prebuild;
40pub mod e_prompts;
41pub mod e_runall;
42pub mod e_target;
43pub mod e_tui;
44pub mod e_workspace;
45
46#[allow(unused_macros)]
47macro_rules! doc_with_joke {
48    (
49        $(#[$attr:meta])*
50        $vis:vis fn $name:ident($($arg:tt)*) -> $ret:ty $body:block
51    ) => {
52        $(#[$attr])*                           // Re-emit external doc attributes.
53        #[doc = "Have you read the Guide for You To Read?"] // Extra injected doc comment.
54        $vis fn $name($($arg)*) -> $ret $body    // Emit the function.
55    };
56}
57
58// Define the helper macro.
59// macro_rules! doc_with_funny {
60//     ($doc:expr) => {
61//         #[doc = concat!($doc, "\n\nSee also the [Guide for You To Read](index.html) for more details.")]
62//     };
63// }
64
65// Define the helper macro that captures external attributes and injects an extra doc attribute.
66// macro_rules! doc_with_funny {
67//     (
68//         $(#[$attr:meta])*
69//         $vis:vis fn $name:ident($($arg:tt)*) -> $ret:ty $body:block
70//     ) => {
71//         $(#[$attr])*                           // Re-emit external doc attributes.
72//         #[doc = "Have you read the Guide for You To Read?"] // Extra injected doc comment.
73//         $vis fn $name($($arg)*) -> $ret $body    // Emit the function.
74//     };
75// }
76
77// #[doc = include_str!("../documents/guide.md")]
78// pub mod a_guide {
79//     /// An example constant to force module inclusion.
80//     doc_with_guide!("This function does something important.");
81//     pub const a_const: () = ();
82
83//     /// An example function to force module inclusion.
84//     pub fn a_function() {}
85
86//     /// An example struct to force module inclusion.
87//     pub struct AStruct;
88
89//     /// An example enum to force module inclusion.
90//     pub enum AEnum {
91//         AVariant,
92//     }
93
94//     /// An example trait to force module inclusion.
95//     pub trait ATrait {}
96
97//     /// An example type alias to force module inclusion.
98//     pub type AType = ();
99// }
100
101// // Re-export so the module shows in the public API.
102// pub use a_guide as __THE_GUIDE;
103
104#[macro_use]
105pub mod a_funny_docs;
106
107#[doc = include_str!("../documents/guide.md")]
108pub mod a_guide {
109    // A constant with a humorous aside
110    #[doc = "A wacky constant that reminds you of the fleeting nature of existence—because constants, like our dreams, never change."]
111    #[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."]
112    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON THE MYSTERIES OF CONSTANTS."]
113    pub const A_CONST: () = ();
114    // A function with a humorous aside
115    #[doc = "An eccentric function that performs its task with a whimsical twist."]
116    #[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."]
117    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON THE ART OF FUNCTIONAL HUMOR."]
118    pub fn a_function() {}
119
120    // A struct with a humorous aside
121    #[doc = "A delightfully absurd struct that encapsulates the essence of lighthearted programming."]
122    #[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."]
123    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON STRUCTURING YOUR HUMOR."]
124    pub struct AStruct;
125
126    // An enum with a humorous aside
127    #[doc = "An enum whose variants are as unpredictable as the punchline of an offbeat comedy routine."]
128    #[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."]
129    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON ENUMERATING THE LAUGHTER."]
130    //#[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.")]
131    pub enum AEnum {
132        #[doc = "A variant that boldly goes where no variant has gone before—capturing the essence of unexpected hilarity."]
133        AVariant,
134    }
135
136    // A trait with a humorous aside
137    #[doc = "A quirky trait that defines behaviors with a tongue-in-cheek twist."]
138    #[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."]
139    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON TRAIT-ORIENTED COMEDY."]
140    pub trait ATrait {}
141
142    // A type alias with a humorous aside
143    #[doc = "A type alias that serves as a humorous shortcut to a more verbose reality."]
144    #[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."]
145    #[doc = "SEE ALSO THE **[GUIDE FOR YOU TO READ](index.html) FOR MORE DETAILS** ON ALIASING THE ORDINARY INTO THE EXTRAORDINARY."]
146    pub type AType = ();
147}
148
149/// If you didn't get it the first time, then look again!  
150/// Check out the **[GUIDE FOR YOU TO READ](theSeachIsOver/index.html)** for all the brilliant details you missed.
151pub use a_guide as theSeachIsOver;
cargo_e/lib.rs

cargo_e/
lib.rs
