Struct MultilinePrompt 

pub struct MultilinePrompt { /* private fields */ }

Builder returned by multiline().

Implementations

impl MultilinePrompt

pub fn placeholder(self, v: impl Into<String>) -> Self

Dim text shown in the input area before the user types.

pub fn show_submit(self, v: bool) -> Self

Show a [ submit ] button focused with Tab (default: false, which means double-Enter submits).

pub fn validate<F>(self, f: F) -> Self

where F: Fn(&str) -> Result<(), String> + Send + Sync + 'static,

Validate with an ad-hoc closure.

pub fn rule(self, v: Validator) -> Self

Apply a composed Validator from the rules library.

pub fn validate_with(self, v: Validator) -> Self

👎Deprecated since 0.1.0:

use .rule(...) instead

Deprecated alias for rule.

pub fn run(self) -> Result<String>

Run the prompt to completion.

Trait Implementations

impl Prompt for MultilinePrompt

type Output = String

The value returned to the caller on successful submission.

fn handle(&mut self, key: Key) -> Step<String>

Apply a key press to the prompt’s internal state. Return:

fn render(&self, _ctx: RenderCtx<'_>) -> Frame

Render the prompt’s current state as one frame (a Vec<String>, one entry per terminal row). The runner takes care of writing the frame and clearing it on the next iteration — prompts never call eprintln! themselves.

fn render_answered(&self, value: &String) -> Frame

Render the prompt’s post-submission display. Typically the ◇ question / │ value / │ triple from theme::answered.

fn run_fallback(self) -> Result<String>

Optional non-interactive fallback for piped/CI environments. The default is to refuse — most prompts override this with a numeric or line-buffered alternative.