Merge pull request #72 from jmagnuson/no-runtime-compile-error

Add compile_error! if no runtime is set
jmagnuson · Sep 29, 2024 · fca14fe · fca14fe
2 parents acaafc6 + 9b17424
commit fca14fe
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -20,6 +20,13 @@ Add linemux to your `Cargo.toml` with:
 linemux = "0.3"
 ```
 
+### Feature flags
+
+Note that building with `default-features: false` must also be coupled with activating a desired
+runtime (currently just `tokio`, but eventually others will be supported).
+
+- `tokio`: Use the tokio runtime (default).
+
 ## Example
 
 ```rust,no_run

diff --git a/src/lib.rs b/src/lib.rs
@@ -42,3 +42,6 @@ pub use reader::{Line, MuxedLines};
 
 #[cfg(doctest)]
 doc_comment::doctest!("../README.md");
+
+#[cfg(not(any(feature = "tokio")))]
+compile_error!("At least one runtime feature must be enabled from: [\"tokio\"]");