Struct kaolinite::document::Document

pub struct Document {
    pub info: FileInfo,
    pub rows: Vec<Row>,
    pub modified: bool,
    pub size: Size,
    pub char_ptr: usize,
    pub cursor: Loc,
    pub offset: Loc,
    pub render: String,
    pub needs_rerender: bool,
    pub event_stack: EditStack,
}

A struct that contains all the basic tools necessary to manage documents

Fields

info: FileInfo

The information for the current file

rows: Vec<Row>

All the rows within the document

modified: bool

Boolean that changes when the file is edited via the event executor

size: Size

The size holds how much space the document has to render

char_ptr: usize

A pointer to the character at the current cursor position

cursor: Loc

The position within the terminal

offset: Loc

Stores information about scrolling

render: String

Render cache space for optimisation purposes

needs_rerender: bool

Toggle that determines if the document requires rerendering

event_stack: EditStack

An undo / redo stack

Implementations

impl Document

pub fn new<S: Into<Size>>(size: S) -> Self

Create a new document

The argument size takes in a Size struct. This should store information about the terminal size.

If you plan to implement things like status lines or tabs, you should subtract them from the size height, as this size is purely for the file viewport size.

pub fn open<P: Into<String>>(&mut self, path: P) -> Result<()>

Open a file at a specified path into this document.

This will also reset the cursor position, offset position, file name, contents and line ending information

Errors

Will return Err if path does not exist or the user does not have permission to read from it.

pub fn save(&mut self) -> Result<()>

Save a file

This will reset modified to false, as it has been saved back to it’s original file.

Errors

Will return Err if the file path the document came from wasn’t able to be written to, potentially because of file permission errors.

pub fn save_as(&self, file: &str) -> Result<()>

Save a file to a specified path

Similar to save but takes a file argument, and saves it there. This method also doesn’t change modified.

Errors

Will return Err if the provided file path wasn’t able to be written to, potentially because fo file permission errors.

pub fn execute(&mut self, event: Event) -> Result<Status>

Execute an event in this document

This method is the main method that should be used to modify the document. It takes in an Event enum.

This method also takes advantage of undo & redo functionality, efficient syntax highlighting and the document modificatior indicator and moves your cursor automatically. If you change the rows in the document directly, you will not gain access to these benefits, but you can always manually handle these features if need be.

Errors

Will return Err if the event tried to modifiy data outside the scope of the document.

pub fn forth(&mut self, event: Event) -> Result<Status>

Execute an event, without the undo / redo tracking

Errors

Will error if the location is out of range

pub fn back(&mut self, event: Event) -> Result<Status>

Take in an event and perform the opposite

Errors

Will error if the location is out of range

pub fn goto<L: Into<Loc>>(&mut self, loc: L) -> Result<()>

Move the cursor to a specific x and y coordinate

Errors

Will return Err if the location provided is out of scope of the document.

pub fn goto_x(&mut self, x: usize) -> Result<()>

Move the cursor to a specific x coordinate

Errors

Will return Err if the location provided is out of scope of the document.

pub fn goto_y(&mut self, y: usize) -> Result<()>

Move the cursor to a specific y coordinate

Errors

Will return Err if the location provided is out of scope of the document.

pub fn move_left(&mut self) -> Result<Status>

Move the cursor to the left

Errors

Will return Err if the cursor is out of scope of the document

pub fn move_right(&mut self) -> Result<Status>

Move the cursor to the right

Errors

Will return Err if the cursor is out of scope of the document

pub fn move_up(&mut self) -> Result<Status>

Move the cursor upwards

Errors

Will return Err if the cursor is out of scope of the document

pub fn move_down(&mut self) -> Result<Status>

Move the cursor downwards

Errors

Will return Err if the cursor is out of scope of the document

pub fn line_number(&self, row: usize) -> String

Work out the line number text to use

pub fn status_line_info(&self) -> HashMap<&str, String>

A helper function that returns info about the document in a HashMap type.

It will return (with keys for the hashmap):

• Row number: row
• Column number: column
• Total rows: total
• File name (no path): file
• File name (full path): full_file
• File type: type
• Modifed indicator: modified
• File extension: extension

pub fn render(&self) -> String

Render the document into the correct form

pub fn render_full(&self) -> String

Render the document into the correct form

pub fn raw_to_rows(&self, text: &str) -> Vec<Row>

Take raw text and convert it into Row structs

pub fn row(&self, index: usize) -> Result<&Row>

Return a reference to a row in the document

Errors

This will error if the index is out of range

pub fn row_mut(&mut self, index: usize) -> Result<&mut Row>

Return a mutable reference to a row in the document

Errors

This will error if the index is out of range

pub fn current_row(&self) -> Result<&Row>

Get the current row

Errors

This will error if the cursor position isn’t on a existing row

pub const fn raw_loc(&self) -> Loc

Get the current position in the document

This ought to be used by the document only as it returns the display indices Use the Document::loc function instead.

pub const fn loc(&self) -> Loc

Get the current position in the document

This will return the character and row indices

Trait Implementations

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Document

Returns the “default value” for a type.