Struct EditorSource 

pub struct EditorSource<R: EditorRunner = RealEditorRunner> { /* private fields */ }

Collect input via an external text editor.

Opens the user’s preferred editor (from $VISUAL or $EDITOR) with a temporary file, waits for the user to save and close, then reads the result.

Editor Detection

Editors are detected in this order:

1. $VISUAL environment variable (supports GUI editors)
2. $EDITOR environment variable
3. Platform fallbacks: vim, vi, nano on Unix; notepad on Windows

Example

use standout_input::{InputChain, ArgSource, EditorSource};

// Fall back to editor if no CLI argument
let chain = InputChain::<String>::new()
    .try_source(ArgSource::new("message"))
    .try_source(EditorSource::new());

let message = chain.resolve(&matches)?;

Configuration

let source = EditorSource::new()
    .initial_content("# Enter your message\n\n")
    .extension(".md")
    .require_save(true);

Implementations

impl EditorSource<RealEditorRunner>

pub fn new() -> Self

Create a new editor source using the system editor.

impl<R: EditorRunner> EditorSource<R>

pub fn with_runner(runner: R) -> Self

Create an editor source with a custom runner.

Primarily used for testing to mock editor invocation.

pub fn initial_content(self, content: impl Into<String>) -> Self

Set initial content to populate the editor with.

This can be used to provide a template or instructions.

pub fn extension(self, ext: impl Into<String>) -> Self

Set the file extension for the temporary file.

This affects syntax highlighting in the editor. Default is .txt.

pub fn require_save(self, require: bool) -> Self

Require the user to actually save the file.

If true, the source will return None if the file’s modification time hasn’t changed (i.e., the user closed without saving). Default is false.

pub fn trim(self, trim: bool) -> Self

Control whether to trim whitespace from the result.

Default is true.

impl<R: EditorRunner + 'static> EditorSource<R>

pub fn prompt(&self) -> Result<String, InputError>

Open the editor and return the saved content.

This is the standalone counterpart to InputCollector::collect: it skips the chain machinery (no &ArgMatches to plumb through) and is intended for wizard or REPL flows that drive standout themselves.

Returns InputError::NoInput if stdin is not a TTY or no editor can be detected (the same conditions under which a chain would skip this source). User cancellation is reported as InputError::EditorCancelled when require_save is set and the user exits without saving.

Routes through any installed PromptResponder, so wizard tests can supply the editor’s “saved” content directly without launching $EDITOR.

Trait Implementations

impl<R: Clone + EditorRunner> Clone for EditorSource<R>

fn clone(&self) -> EditorSource<R>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Default for EditorSource<RealEditorRunner>

fn default() -> Self

Returns the “default value” for a type.

impl<R: EditorRunner + 'static> InputCollector<String> for EditorSource<R>

fn name(&self) -> &'static str

Human-readable name for this collector.

fn is_available(&self, _matches: &ArgMatches) -> bool

Check if this collector can provide input in the current environment.

fn collect(&self, _matches: &ArgMatches) -> Result<Option<String>, InputError>

Attempt to collect input from this source.

fn can_retry(&self) -> bool

Whether this collector supports retry on validation failure.

fn validate(&self, _value: &T) -> Result<(), String>

Validate the collected value.