From 439e3975ec52574851259fbc4aeaa87bcf28c78b Mon Sep 17 00:00:00 2001 From: Daniel Date: Mon, 4 May 2020 11:51:28 +0200 Subject: add a bit more docstring to INTERRUPTED --- src/main.rs | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/src/main.rs b/src/main.rs index 0a98c4e..ad35d20 100644 --- a/src/main.rs +++ b/src/main.rs @@ -227,6 +227,12 @@ impl std::error::Error for InputError {} /// A flag that indicates whether the current search should be interrupted because the user pressed /// Crtl-C. +/// +/// This flag can be set to `true` by signal handlers in order to exit the search as early as +/// possible. Note that the search won't be exited immediately, as any logs currently in the +/// process of being parsed will finish to do so. +/// +/// The flag is automatically reset to `false` by the repl. static INTERRUPTED: AtomicBool = AtomicBool::new(false); fn main() { -- cgit v1.2.3