Struct TodoFile

pub struct TodoFile { /* private fields */ }

Represents a rebase file.

Implementations

impl TodoFile

pub fn new<Path: AsRef<Path>>( path: Path, undo_limit: u32, comment_char: &str, ) -> Self

Create a new instance.

pub fn set_lines(&mut self, lines: Vec<Line>)

Set the rebase lines.

pub fn load_file(&mut self) -> Result<(), IoError>

Load the rebase file from disk.

Errors

Returns error if the file cannot be read.

pub fn write_file(&self) -> Result<(), IoError>

Write the rebase file to disk.

Errors

Returns error if the file cannot be written.

pub fn set_selected_line_index(&mut self, selected_line_index: usize) -> usize

Set the selected line index returning the new index based after ensuring within range.

pub fn swap_range_up(&mut self, start_index: usize, end_index: usize) -> bool

Swap a range of lines up.

pub fn swap_range_down(&mut self, start_index: usize, end_index: usize) -> bool

Swap a range of lines down.

pub fn add_line(&mut self, index: usize, line: Line)

Add a new line.

pub fn remove_lines(&mut self, start_index: usize, end_index: usize)

Remove a range of lines.

pub fn update_range( &mut self, start_index: usize, end_index: usize, edit_context: &EditContext, )

Update a range of lines.

pub fn undo(&mut self) -> Option<(usize, usize)>

Undo the last modification.

pub fn redo(&mut self) -> Option<(usize, usize)>

Redo the last undone modification.

pub const fn version(&self) -> &Version

Get the current version

pub fn get_selected_line(&self) -> Option<&Line>

Get the selected line.

pub fn get_max_selected_line_index(&self) -> usize

Get the index of the last line that can be selected.

pub const fn get_selected_line_index(&self) -> usize

Get the selected line index

pub fn get_filepath(&self) -> &Path

Get the file path to the rebase file.

pub fn get_line(&self, index: usize) -> Option<&Line>

Get a line by index.

pub fn get_lines_owned(&self) -> Vec<Line>

Get an owned copy of the lines.

pub const fn is_noop(&self) -> bool

Is the rebase file a noop.

pub fn lines_iter(&self) -> Iter<'_, Line>

Get an iterator over the lines.

pub fn is_empty(&self) -> bool

Does the rebase file contain no lines.

Trait Implementations

impl Debug for TodoFile

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

Formats the value using the given formatter.