Struct EditorCallBuilder

pub struct EditorCallBuilder { /* private fields */ }

Implementations

impl EditorCallBuilder

pub fn new<P: AsRef<Path>>(file_path: P) -> Result<Self, OpenEditorError>

Creates a new EditorCallBuilder with the given file path. You can optionally set the line and column numbers later using the at_line and at_column methods. Finally, you can call the call_editor method to open the editor.

The editor to use is determined by the VISUAL and EDITOR environment variables, in that order.

Errors

This function will return an error if the default editor cannot be found in the environment variables.

Examples found in repository

examples/independant_editor.rs (line 6)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let filename = "./test";

    EditorCallBuilder::new(filename)?
        .wait_for_editor(false)
        .call_editor()?;

    Ok(())
}

examples/interactive_edit.rs (line 10)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let (filename, line, column) = get_parameters()?;

    EditorCallBuilder::new(filename)?
        .at_line(line)
        .at_column(column)
        .call_editor()?;

    Ok(())
}

pub fn new_with_env_vars<P: AsRef<Path>>( file_path: P, env_vars: &[&str], ) -> Result<Self, OpenEditorError>

Similar to EditorCallBuilder::new, but allows specifying the environment variables to use to find the editor.

pub fn at_line(self, line: usize) -> Self

Sets the line number for the editor to open at.

Examples found in repository

examples/interactive_edit.rs (line 11)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let (filename, line, column) = get_parameters()?;

    EditorCallBuilder::new(filename)?
        .at_line(line)
        .at_column(column)
        .call_editor()?;

    Ok(())
}

pub fn at_column(self, line: usize) -> Self

Sets the column number for the editor to open at.

Examples found in repository

examples/interactive_edit.rs (line 12)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let (filename, line, column) = get_parameters()?;

    EditorCallBuilder::new(filename)?
        .at_line(line)
        .at_column(column)
        .call_editor()?;

    Ok(())
}

pub fn wait_for_editor(self, value: bool) -> Self

Whether to wait for the editor to close before returning.

Examples found in repository

examples/independant_editor.rs (line 7)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let filename = "./test";

    EditorCallBuilder::new(filename)?
        .wait_for_editor(false)
        .call_editor()?;

    Ok(())
}

pub fn call_editor(&self) -> Result<(), OpenEditorError>

Calls the editor with options from the EditorCallBuilder.

Errors

This function will return an error if the commands fails to execute or if the editor returns a non-zero exit code.

Examples found in repository

examples/independant_editor.rs (line 8)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let filename = "./test";

    EditorCallBuilder::new(filename)?
        .wait_for_editor(false)
        .call_editor()?;

    Ok(())
}

examples/interactive_edit.rs (line 13)

fn main() -> Result<(), Box<dyn std::error::Error>> {
    let (filename, line, column) = get_parameters()?;

    EditorCallBuilder::new(filename)?
        .at_line(line)
        .at_column(column)
        .call_editor()?;

    Ok(())
}