better inline docs

cozo-core/src/lib.rs

@@ -67,6 +67,7 @@ pub use crate::data::expr::Expr;
 use crate::data::json::JsonValue;
 pub use crate::data::symb::Symbol;
 pub use crate::runtime::callback::CallbackOp;
+pub use crate::runtime::db::Poison;
 
 #[cfg(not(target_arch = "wasm32"))]
 pub(crate) mod data;

cozo-core/src/runtime/db.rs

@@ -1423,12 +1423,14 @@ impl<'s, S: Storage<'s>> Db<S> {
     }
 }
 
+/// Used for user-initiated termination of running queries
 #[derive(Clone, Default)]
 pub struct Poison(pub(crate) Arc<AtomicBool>);
 
 impl Poison {
+    /// Will return `Err` if user has initiated termination.
     #[inline(always)]
-    pub(crate) fn check(&self) -> Result<()> {
+    pub fn check(&self) -> Result<()> {
         #[derive(Debug, Error, Diagnostic)]
         #[error("Running query is killed before completion")]
         #[diagnostic(code(eval::killed))]