refactor: Expose timeout setting to user

Author: shannmu

crates/completest-nu/src/lib.rs

@@ -26,6 +26,7 @@ use std::ffi::OsString;
 use std::path::Path;
 use std::path::PathBuf;
 use std::sync::Arc;
+use std::time::Duration;
 
 use nu_cli::NuCompleter;
 use nu_command::add_shell_command_context;
@@ -106,7 +107,12 @@ impl NuRuntime {
     }
 
     /// Get the output from typing `input` into the shell
-    pub fn complete(&mut self, input: &str, term: &Term) -> std::io::Result<String> {
+    pub fn complete(
+        &mut self,
+        input: &str,
+        term: &Term,
+        timeout: Duration,
+    ) -> std::io::Result<String> {
         use std::fmt::Write as _;
 
         let input = input.split_once('\t').unwrap_or((input, "")).0;
@@ -163,8 +169,8 @@ impl Runtime for NuRuntime {
         self.register(name, content)
     }
 
-    fn complete(&mut self, input: &str, term: &Term) -> std::io::Result<String> {
-        self.complete(input, term)
+    fn complete(&mut self, input: &str, term: &Term, timeout: Duration) -> std::io::Result<String> {
+        self.complete(input, term, timeout)
     }
 }
 

crates/completest-pty/src/lib.rs

@@ -63,7 +63,7 @@ impl RuntimeBuilder for ZshRuntimeBuilder {
 pub struct ZshRuntime {
     path: OsString,
     home: PathBuf,
-    timeout: Duration,
+    _timeout: Duration,
 }
 
 impl ZshRuntime {
@@ -93,7 +93,7 @@ PROMPT='%% '
         Ok(Self {
             path,
             home,
-            timeout: Duration::from_millis(100),
+            _timeout: Duration::from_millis(100),
         })
     }
 
@@ -110,15 +110,20 @@ PROMPT='%% '
     }
 
     /// Get the output from typing `input` into the shell
-    pub fn complete(&mut self, input: &str, term: &Term) -> std::io::Result<String> {
+    pub fn complete(
+        &mut self,
+        input: &str,
+        term: &Term,
+        timeout: Duration,
+    ) -> std::io::Result<String> {
         let mut command = Command::new("zsh");
         command.arg("--noglobalrcs");
         command
             .env("PATH", &self.path)
             .env("TERM", "xterm")
             .env("ZDOTDIR", &self.home);
         let echo = false;
-        comptest(command, echo, input, term, self.timeout)
+        comptest(command, echo, input, term, timeout)
     }
 }
 
@@ -131,8 +136,8 @@ impl Runtime for ZshRuntime {
         self.register(name, content)
     }
 
-    fn complete(&mut self, input: &str, term: &Term) -> std::io::Result<String> {
-        self.complete(input, term)
+    fn complete(&mut self, input: &str, term: &Term, timeout: Duration) -> std::io::Result<String> {
+        self.complete(input, term, timeout)
     }
 }
 
@@ -164,7 +169,7 @@ pub struct BashRuntime {
     path: OsString,
     home: PathBuf,
     config: PathBuf,
-    timeout: Duration,
+    _timeout: Duration,
 }
 
 impl BashRuntime {
@@ -198,7 +203,7 @@ PS1='% '
             path,
             home,
             config: config_path,
-            timeout: Duration::from_millis(50),
+            _timeout: Duration::from_millis(50),
         })
     }
 
@@ -217,7 +222,12 @@ PS1='% '
     }
 
     /// Get the output from typing `input` into the shell
-    pub fn complete(&mut self, input: &str, term: &Term) -> std::io::Result<String> {
+    pub fn complete(
+        &mut self,
+        input: &str,
+        term: &Term,
+        timeout: Duration,
+    ) -> std::io::Result<String> {
         let mut command = Command::new("bash");
         let inputrc_path = self.home.join(".inputrc");
         command
@@ -226,7 +236,7 @@ PS1='% '
             .env("INPUTRC", &inputrc_path)
             .args([OsStr::new("--rcfile"), self.config.as_os_str()]);
         let echo = !input.contains("\t\t");
-        comptest(command, echo, input, term, self.timeout)
+        comptest(command, echo, input, term, timeout)
     }
 }
 
@@ -239,8 +249,8 @@ impl Runtime for BashRuntime {
         self.register(name, content)
     }
 
-    fn complete(&mut self, input: &str, term: &Term) -> std::io::Result<String> {
-        self.complete(input, term)
+    fn complete(&mut self, input: &str, term: &Term, timeout: Duration) -> std::io::Result<String> {
+        self.complete(input, term, timeout)
     }
 }
 
@@ -271,7 +281,7 @@ impl RuntimeBuilder for FishRuntimeBuilder {
 pub struct FishRuntime {
     path: OsString,
     home: PathBuf,
-    timeout: Duration,
+    _timeout: Duration,
 }
 
 impl FishRuntime {
@@ -303,7 +313,7 @@ end;
         Ok(Self {
             path,
             home,
-            timeout: Duration::from_millis(50),
+            _timeout: Duration::from_millis(50),
         })
     }
 
@@ -320,15 +330,20 @@ end;
     }
 
     /// Get the output from typing `input` into the shell
-    pub fn complete(&mut self, input: &str, term: &Term) -> std::io::Result<String> {
+    pub fn complete(
+        &mut self,
+        input: &str,
+        term: &Term,
+        timeout: Duration,
+    ) -> std::io::Result<String> {
         let mut command = Command::new("fish");
         command
             .env("PATH", &self.path)
             // fish requires TERM to be set.
             .env("TERM", "xterm")
             .env("XDG_CONFIG_HOME", &self.home);
         let echo = false;
-        comptest(command, echo, input, term, self.timeout)
+        comptest(command, echo, input, term, timeout)
     }
 }
 
@@ -341,8 +356,8 @@ impl Runtime for FishRuntime {
         self.register(name, content)
     }
 
-    fn complete(&mut self, input: &str, term: &Term) -> std::io::Result<String> {
-        self.complete(input, term)
+    fn complete(&mut self, input: &str, term: &Term, timeout: Duration) -> std::io::Result<String> {
+        self.complete(input, term, timeout)
     }
 }
 
@@ -374,7 +389,7 @@ pub struct ElvishRuntime {
     path: OsString,
     home: PathBuf,
     config: PathBuf,
-    timeout: Duration,
+    _timeout: Duration,
 }
 
 impl ElvishRuntime {
@@ -403,7 +418,7 @@ set edit:prompt = (constantly \"% \")
             path,
             home,
             config: config_path,
-            timeout: Duration::from_millis(50),
+            _timeout: Duration::from_millis(50),
         })
     }
 
@@ -422,13 +437,18 @@ set edit:prompt = (constantly \"% \")
     }
 
     /// Get the output from typing `input` into the shell
-    pub fn complete(&mut self, input: &str, term: &Term) -> std::io::Result<String> {
+    pub fn complete(
+        &mut self,
+        input: &str,
+        term: &Term,
+        timeout: Duration,
+    ) -> std::io::Result<String> {
         let mut command = Command::new("elvish");
         command
             .env("PATH", &self.path)
             .env("XDG_CONFIG_HOME", &self.home);
         let echo = false;
-        comptest(command, echo, input, term, self.timeout)
+        comptest(command, echo, input, term, timeout)
     }
 }
 
@@ -441,8 +461,8 @@ impl Runtime for ElvishRuntime {
         self.register(name, content)
     }
 
-    fn complete(&mut self, input: &str, term: &Term) -> std::io::Result<String> {
-        self.complete(input, term)
+    fn complete(&mut self, input: &str, term: &Term, timeout: Duration) -> std::io::Result<String> {
+        self.complete(input, term, timeout)
     }
 }
 

src/lib.rs

@@ -8,6 +8,8 @@
 #![warn(clippy::print_stderr)]
 #![warn(clippy::print_stdout)]
 
+use std::time::Duration;
+
 /// Terminal that shell's will run completions in
 #[derive(Debug)]
 pub struct Term {
@@ -78,5 +80,5 @@ pub trait Runtime: std::fmt::Debug {
     fn register(&mut self, name: &str, content: &str) -> std::io::Result<()>;
 
     /// Get the output from typing `input` into the shell
-    fn complete(&mut self, input: &str, term: &Term) -> std::io::Result<String>;
+    fn complete(&mut self, input: &str, term: &Term, timout: Duration) -> std::io::Result<String>;
 }