Function inquire::prompt_secret
source · pub fn prompt_secret<M>(message: M) -> InquireResult<String>
Expand description
This function is a helpful one-liner to prompt the user for a password, or any secret text.
Under the hood, it is equivalent to calling inquire::Password::new(message).prompt()
.
See the documentation for [inquire::Password
] for more information on its behavior.
§Arguments
message
: A message that implements theAsRef<str>
trait. This message will be displayed to the user when asking for input.
§Returns
InquireResult<String>
: An enum that represents the result of the prompt operation. If the operation is successful, it returnsInquireResult::Ok(String)
where the String represents the user’s input. If the operation encounters an error, it returnsInquireResult::Err(InquireError)
.
§Example
let token = prompt_secret("Access Token:")?;
§Errors
This function will return an error if there is a problem interacting with the terminal, or if the user
cancels the operation by pressing Ctrl+C
.