Struct Editor 

pub struct Editor { /* private fields */ }

Allows for text input in the configured editor.

Implementations

impl Editor

pub fn new(path: impl AsRef<Path>) -> Result<Editor, Error>

Create a new editor.

pub fn comment() -> Editor

pub fn extension(self, ext: &str) -> Editor

Set the file extension.

pub fn truncate(self, truncate: bool) -> Editor

Truncate the file to length 0 when opening

pub fn cleanup(self, cleanup: bool) -> Editor

Clean up the file after the Editor is dropped.

pub fn initial(self, content: impl AsRef<[u8]>) -> Result<Editor, Error>

Initialize the file with the provided content, as long as the file does not already contain anything.

pub fn edit(&mut self) -> Result<Option<String>, Error>

Open the editor and return the edited text.

If the text hasn’t changed from the initial contents of the editor, return None.

Trait Implementations

impl Default for Editor

fn default() -> Editor

Returns the “default value” for a type.

impl Drop for Editor

fn drop(&mut self)

Executes the destructor for this type.