Struct dialoguer::Editor

pub struct Editor { /* private fields */ }

Launches the default editor to edit a string.

Example

use dialoguer::Editor;

if let Some(rv) = Editor::new().edit("Enter a commit message").unwrap() {
    println!("Your message:");
    println!("{}", rv);
} else {
    println!("Abort!");
}

Implementations

impl Editor

pub fn new() -> Self

Creates a new editor.

Examples found in repository

examples/editor.rs (line 4)

fn main() {
    if let Some(rv) = Editor::new().edit("Enter a commit message").unwrap() {
        println!("Your message:");
        println!("{}", rv);
    } else {
        println!("Abort!");
    }
}

pub fn executable<S: AsRef<OsStr>>(&mut self, val: S) -> &mut Self

Sets a specific editor executable.

pub fn extension(&mut self, val: &str) -> &mut Self

Sets a specific extension

pub fn require_save(&mut self, val: bool) -> &mut Self

Enables or disables the save requirement.

pub fn trim_newlines(&mut self, val: bool) -> &mut Self

Enables or disables trailing newline stripping.

This is on by default.

pub fn edit(&self, s: &str) -> Result<Option<String>>

Launches the editor to edit a string.

Returns None if the file was not saved or otherwise the entered text.

Examples found in repository

examples/editor.rs (line 4)

fn main() {
    if let Some(rv) = Editor::new().edit("Enter a commit message").unwrap() {
        println!("Your message:");
        println!("{}", rv);
    } else {
        println!("Abort!");
    }
}

Trait Implementations

impl Default for Editor

fn default() -> Self

Returns the “default value” for a type.