Struct bo::Document

pub struct Document {
    rows: Vec<Row>,
    pub filename: Option<PathBuf>,
}

Fields

rows: Vec<Row>

filename: Option<PathBuf>

Implementations

impl Document

pub fn new(rows: Vec<Row>, filename: PathBuf) -> Self

pub fn new_empty(filename: PathBuf) -> Self

pub fn swap_filename(filename: &Path) -> PathBuf

Panics

This function will panic if the path contains a non UTF-8 character

pub fn open(filename: PathBuf) -> Result<Self, Error>

Errors

Panics

Returns an error if a file bearing the provided filename cannot be open.

pub fn save_to_swap_file(&self) -> Result<(), Error>

Errors

Panics

Can return an error if the file can’t be created or written to.

pub fn trim_trailing_spaces(&mut self)

pub fn save(&self) -> Result<(), Error>

Errors

Panics

Can return an error if the file can’t be created or written to.

pub fn save_as(&mut self, new_name: &str) -> Result<(), Error>

Errors

Panics

Can return an error if the file can’t be created or written to.

pub fn get_row(&self, index: RowIndex) -> Option<&Row>

pub fn remove_row(&mut self, index: RowIndex) -> Row

pub fn row_lengths(&self) -> Vec<usize>

pub fn is_empty(&self) -> bool

pub fn num_rows(&self) -> usize

pub fn num_words(&self) -> usize

pub fn row_for_line_number(&self, line_number: LineNumber) -> Option<&Row>

Get the document row corresponding to a given line number

pub fn last_line_number(&self) -> LineNumber

Return the line number of the last line in the file

pub fn iter(&self) -> Iter<'_, Row>

pub fn iter_mut(&mut self) -> IterMut<'_, Row>

pub fn insert_string(&mut self, text: &str, x: usize, y: RowIndex)

pub fn insert_newline(&mut self, x: usize, y: RowIndex)

pub fn insert(&mut self, c: char, x: usize, y: RowIndex)

pub fn delete_string(&mut self, text: &str, x: usize, y: RowIndex)

pub fn delete(&mut self, x: usize, from_x: usize, y: RowIndex)

pub fn delete_row(&mut self, index: RowIndex)

pub fn join_row_with_previous_one(
    &mut self,
    x: usize,
    y: RowIndex,
    join_with: Option<char>
)

pub fn hashed(&self) -> u64

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() -> Self

Returns the “default value” for a type.

impl Hash for Document

fn hash<H: Hasher>(&self, state: &mut H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl Serialize for Document

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error> where
    __S: Serializer, 

Serialize this value into the given Serde serializer.