Struct Vipe 

#[non_exhaustive]
pub struct Vipe { /* private fields */ }

Runtime engine for one vipe invocation. Constructed via VipeBuilder.

Implementations

impl Vipe

pub fn run<R: Read, W: Write>( &mut self, reader: R, writer: W, ) -> Result<(), Error>

Drain reader to a tempfile, spawn the editor against it, then write the post-edit tempfile bytes to writer.

On non-zero editor exit, writer is NOT touched and the call returns Err(Error::EditorNonZeroExit(code)) with the already-clamped code (Unix 1–255 verbatim; Windows 1–254 verbatim, else clamped to 1).

Writer-untouched invariant: writer receives zero bytes (and zero flush() calls) on every error path — EditorNonZeroExit, TempFileDeleted, NoControllingTty, InvalidEditorCommand, EditorNotFound, and any underlying Io error during the drain/spawn/read phases. Only the final successful read-and-write step touches writer. See FR-029 for the formal contract.

Trait Implementations

impl Debug for Vipe

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.