Struct scrawl::editor::Editor

pub struct Editor<S: EditorState> { /* private fields */ }

This is the struct that allows the caller to customize which editor is called, what it is seeded with, and more.

Implementations

impl Editor<DefaultState>

pub fn ext<S: AsRef<str>>(&mut self, ext: S) -> &mut Self

Specify which extension should be used on the temporary file (often used by text editors to infer syntax highlighting).

pub fn editor<S: AsRef<OsStr>>(self, editor: S) -> Editor<SpecificEditorState>

Specify which editor should be opened instead of the user’s default.

pub fn open(&mut self, contents: Contents<'_>) -> Result<Reader, Box<dyn Error>>

Opens the user’s editor.

pub fn edit<P: AsRef<Path>>(&mut self, path: P) -> Result<Reader, Box<dyn Error>>

Opens a file for editing in the User’s editor.

impl Editor<SpecificEditorState>

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

Add arguments that you want to be used when the command is run. The first argument is always the file being used as the buffer. Requires that a specific editor has been set.

pub fn ext<S: AsRef<str>>(&mut self, ext: S) -> &mut Self

Specify which extension should be used on the temporary file (often used by text editors to infer syntax highlighting).

pub fn open(&mut self, contents: Contents<'_>) -> Result<Reader, Box<dyn Error>>

Opens the user’s editor.

pub fn edit<P: AsRef<Path>>(&mut self, path: P) -> Result<Reader, Box<dyn Error>>

Opens a file for editing in the User’s editor.

Trait Implementations

impl<S: Debug + EditorState> Debug for Editor<S>

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

Formats the value using the given formatter.