Struct EditorBuilder

pub struct EditorBuilder<'a> { /* private fields */ }

A builder for a Command that will open the user’s configured editor. For simple cases you probably can just use EditorBuilder::edit_file. See crate-level documentation for more details and examples.

Implementations

impl<'a> EditorBuilder<'a>

pub fn new() -> Self

Create a new editor command with no sources. You probably want to call environment on the returned value.

pub fn edit_file(path: impl AsRef<Path>) -> Result<Command, EditorBuilderError>

Shorthand for opening a file with the command set in VISUAL/EDITOR.

EditorBuilder::edit_file("file.yml")

is equivalent to:

EditorBuilder::new().environment().path(path).build()

pub fn source(self, source: Option<impl Into<Cow<'a, str>>>) -> Self

Add a static string as a source for the command. This is useful for static defaults, or external sources such as a configuration file. This accepts an Option so you can easily build a chain of sources that may or may not be defined.

pub fn environment(self) -> Self

Add the VISUAL and EDITOR environment variables, in that order. The variables will be evaluated immediately, not during build.

pub fn path(self, path: impl Into<Cow<'a, Path>>) -> Self

Define the path to be passed as the final argument.

Multiple Calls

Subsequent calls to this on the same instance will append to the list of paths. The paths will all be included in the final command, in the order this method was called.

pub fn build(self) -> Result<Command, EditorBuilderError>

Search all configured sources (in their order of definition), and parse the first one that’s populated as a shell command. Then use that to build an executable Command.

Trait Implementations

impl<'a> Clone for EditorBuilder<'a>

fn clone(&self) -> EditorBuilder<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for EditorBuilder<'a>

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

Formats the value using the given formatter.

impl<'a> Default for EditorBuilder<'a>

fn default() -> EditorBuilder<'a>

Returns the “default value” for a type.