doc: add comment to time_remaining function

extism · May 22, 2024 · 289fa3f · 289fa3f
1 parent d22bea8
commit 289fa3f
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/runtime/src/current_plugin.rs b/runtime/src/current_plugin.rs
@@ -455,6 +455,8 @@ impl CurrentPlugin {
         (offs, length)
     }
 
+    /// Returns the remaining time before a plugin will timeout, or
+    /// `None` if no timeout is configured in the manifest
     pub fn time_remaining(&self) -> Option<std::time::Duration> {
         if let Some(x) = &self.manifest.timeout_ms {
             let elapsed = &self.start_time.elapsed().as_millis();