texter 0.3.0

A library that simplifies writing an LSP with tree-sitter
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61

use std::{fmt::Display, num::NonZeroUsize};

/// A type alias for the libraries result type. ([`Result<(), Error>`])
pub type Result<T> = std::result::Result<T, Error>;

/// The error type returned upon failed conversions and edits across the library.
#[derive(Clone, Debug, PartialEq, Eq)]
#[non_exhaustive]
pub enum Error {
    OutOfBoundsRow { max: usize, current: usize },
    InBetweenCharBoundries { encoding: Encoding },
}

#[derive(Clone, Copy, Debug, PartialEq, Eq)]
pub enum Encoding {
    UTF8,
    UTF16,
    UTF32,
}

impl Display for Error {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            Self::OutOfBoundsRow { max, current } => {
                write!(f, "Current max row index is {max}, {current} was provided.")
            }
            Self::InBetweenCharBoundries { encoding } => {
                write!(
                    f,
                    "Provided column position is between char boundries for {encoding:?}."
                )
            }
        }
    }
}

impl Error {
    #[inline]
    pub(crate) fn oob_row(row_count: NonZeroUsize, current: usize) -> Self {
        Self::OutOfBoundsRow {
            max: row_count.get() - 1,
            current,
        }
    }

    /// Check if the error is caused by a single missing newline
    ///
    /// Some LSP servers and clients may assume an extra newline exists at the end.
    /// In the majority of these cases the correct fix is to append an empty line to the string.
    /// This function returns [`true`] if the error can be fixed/ignored by appending a newline.
    #[inline]
    pub fn is_missing_newline(self) -> bool {
        if let Self::OutOfBoundsRow { max, current } = self {
            max + 1 == current
        } else {
            false
        }
    }
}

impl std::error::Error for Error {}