Struct EditorCallBuilder 

pub struct EditorCallBuilder { /* private fields */ }

Implementations

impl EditorCallBuilder

pub fn new() -> Self

Creates a new EditorCallBuilder. You can optionally set the line and column numbers later using the at_line and at_column methods.

Finally, you can call the editor with the open_editor, edit_string, or edit_string_mut methods.

Errors

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

Examples found in repository

examples/get_user_input.rs (line 4)

fn main() -> Result<(), OpenEditorError> {
    let user_input = EditorCallBuilder::new().open_editor()?;
    println!("User input:\n{user_input}");
    Ok(())
}

examples/custom_env_vars.rs (line 4)

fn main() -> Result<(), OpenEditorError> {
    let user_input = EditorCallBuilder::new()
        .with_env_vars(&["MY_EDITOR"])
        .open_editor()?;
    println!("User input:\n{user_input}");
    Ok(())
}

examples/custom_editor.rs (line 4)

fn main() -> Result<(), OpenEditorError> {
    let user_input = EditorCallBuilder::new()
        .with_editor(Editor::from_editor_kind(EditorKind::Nano))
        .open_editor()?;
    println!("User input:\n{user_input}");
    Ok(())
}

examples/interactive_edit.rs (line 11)

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

    EditorCallBuilder::new()
        .at_line(line)
        .at_column(column)
        .open_file(&file_path)?;
    Ok(())
}

examples/independant_editor.rs (line 11)

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

    // Spawn editor without waiting
    EditorCallBuilder::new()
        .wait_for_editor(false)
        .open_file(&filename)?;

    println!("Editor launched. Press Ctrl+C to stop.\n");

    loop {
        let contents = fs::read_to_string(&filename).unwrap_or_default();

        println!("--- Content of {} ---\n{}\n", filename.display(), contents);

        sleep(Duration::from_secs(1));
    }
}

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 12)

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

    EditorCallBuilder::new()
        .at_line(line)
        .at_column(column)
        .open_file(&file_path)?;
    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 13)

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

    EditorCallBuilder::new()
        .at_line(line)
        .at_column(column)
        .open_file(&file_path)?;
    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 12)

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

    // Spawn editor without waiting
    EditorCallBuilder::new()
        .wait_for_editor(false)
        .open_file(&filename)?;

    println!("Editor launched. Press Ctrl+C to stop.\n");

    loop {
        let contents = fs::read_to_string(&filename).unwrap_or_default();

        println!("--- Content of {} ---\n{}\n", filename.display(), contents);

        sleep(Duration::from_secs(1));
    }
}

pub fn with_env_vars(self, env_vars: &[&str]) -> Self

Add additional environment variables to look for the editor in. These variables will have higher priority than VISUAL and EDITOR.

Examples found in repository

examples/custom_env_vars.rs (line 5)

fn main() -> Result<(), OpenEditorError> {
    let user_input = EditorCallBuilder::new()
        .with_env_vars(&["MY_EDITOR"])
        .open_editor()?;
    println!("User input:\n{user_input}");
    Ok(())
}

pub fn with_editor(self, editor: Editor) -> Self

Sets a specific editor to use instead of the default one.

Examples found in repository

examples/custom_editor.rs (line 5)

fn main() -> Result<(), OpenEditorError> {
    let user_input = EditorCallBuilder::new()
        .with_editor(Editor::from_editor_kind(EditorKind::Nano))
        .open_editor()?;
    println!("User input:\n{user_input}");
    Ok(())
}

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

Open the default editor and returns what was written in it.

Errors

If the editor call fails, or if the temporary file cannot be read or cleaned up, or if the editor call fails.

Examples found in repository

examples/get_user_input.rs (line 4)

fn main() -> Result<(), OpenEditorError> {
    let user_input = EditorCallBuilder::new().open_editor()?;
    println!("User input:\n{user_input}");
    Ok(())
}

examples/custom_env_vars.rs (line 6)

fn main() -> Result<(), OpenEditorError> {
    let user_input = EditorCallBuilder::new()
        .with_env_vars(&["MY_EDITOR"])
        .open_editor()?;
    println!("User input:\n{user_input}");
    Ok(())
}

examples/custom_editor.rs (line 6)

fn main() -> Result<(), OpenEditorError> {
    let user_input = EditorCallBuilder::new()
        .with_editor(Editor::from_editor_kind(EditorKind::Nano))
        .open_editor()?;
    println!("User input:\n{user_input}");
    Ok(())
}

pub fn edit_string_mut( &self, string: &mut String, ) -> Result<(), OpenEditorError>

Open the default editor and allows editing of a mutable string.

Errors

If the editor call fails, or if the temporary file cannot be read or cleaned up, or if the editor call fails.

pub fn edit_string(&self, string: &str) -> Result<String, OpenEditorError>

Open the default editor and allows editing of a string which is then returned.

Errors

If the editor call fails, or if the temporary file cannot be read or cleaned up, or if the editor call fails.

pub fn open_file(&self, file_path: &Path) -> Result<(), OpenEditorError>

Opens the specified file in the editor.

Errors

This function will return an error if the editor call fails or if the file cannot be read.

Examples found in repository

examples/interactive_edit.rs (line 14)

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

    EditorCallBuilder::new()
        .at_line(line)
        .at_column(column)
        .open_file(&file_path)?;
    Ok(())
}

examples/independant_editor.rs (line 13)

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

    // Spawn editor without waiting
    EditorCallBuilder::new()
        .wait_for_editor(false)
        .open_file(&filename)?;

    println!("Editor launched. Press Ctrl+C to stop.\n");

    loop {
        let contents = fs::read_to_string(&filename).unwrap_or_default();

        println!("--- Content of {} ---\n{}\n", filename.display(), contents);

        sleep(Duration::from_secs(1));
    }
}

Trait Implementations

impl Default for EditorCallBuilder

fn default() -> Self

Returns the “default value” for a type.