summaryrefslogtreecommitdiffstats
path: root/vendor/gix-prompt/src/lib.rs
diff options
context:
space:
mode:
Diffstat (limited to 'vendor/gix-prompt/src/lib.rs')
-rw-r--r--vendor/gix-prompt/src/lib.rs76
1 files changed, 76 insertions, 0 deletions
diff --git a/vendor/gix-prompt/src/lib.rs b/vendor/gix-prompt/src/lib.rs
new file mode 100644
index 000000000..75cc1ebd5
--- /dev/null
+++ b/vendor/gix-prompt/src/lib.rs
@@ -0,0 +1,76 @@
+//! Git style prompting with support for `GIT_ASKPASS` and `askpass` program configuration.
+//!
+//! ### Compatibility
+//!
+//! This is a unix-only crate which will return with an error when trying to obtain any prompt on other platforms.
+//! On those platforms it is common to have helpers which perform this task so it shouldn't be a problem.
+#![deny(rust_2018_idioms, missing_docs)]
+#![forbid(unsafe_code)]
+
+mod types;
+pub use types::{Error, Mode, Options};
+
+///
+pub mod unix;
+#[cfg(unix)]
+use unix::imp;
+
+#[cfg(not(unix))]
+mod imp {
+ use crate::{Error, Options};
+
+ pub(crate) fn ask(_prompt: &str, _opts: &Options<'_>) -> Result<String, Error> {
+ Err(Error::UnsupportedPlatform)
+ }
+}
+
+/// Ask the user given a `prompt`, returning the result.
+pub fn ask(prompt: &str, opts: &Options<'_>) -> Result<String, Error> {
+ if let Some(askpass) = opts.askpass.as_deref() {
+ match gix_command::prepare(askpass).arg(prompt).spawn() {
+ Ok(cmd) => {
+ if let Some(mut stdout) = cmd
+ .wait_with_output()
+ .ok()
+ .and_then(|out| String::from_utf8(out.stdout).ok())
+ {
+ if stdout.ends_with('\n') {
+ stdout.pop();
+ }
+ if stdout.ends_with('\r') {
+ stdout.pop();
+ }
+ return Ok(stdout);
+ }
+ }
+ Err(err) => eprintln!("Cannot run askpass program: {askpass:?} with error: {err}"),
+ }
+ }
+ imp::ask(prompt, opts)
+}
+
+/// Ask for information typed by the user into the terminal after showing the prompt`, like `"Username: `.
+///
+/// Use [`ask()`] for more control.
+pub fn openly(prompt: impl AsRef<str>) -> Result<String, Error> {
+ imp::ask(
+ prompt.as_ref(),
+ &Options {
+ mode: Mode::Visible,
+ askpass: None,
+ },
+ )
+}
+
+/// Ask for information _securely_ after showing the `prompt` (like `"password: "`) by not showing what's typed.
+///
+/// Use [`ask()`] for more control.
+pub fn securely(prompt: impl AsRef<str>) -> Result<String, Error> {
+ imp::ask(
+ prompt.as_ref(),
+ &Options {
+ mode: Mode::Hidden,
+ askpass: None,
+ },
+ )
+}