scribe 0.10.0

Text editor toolkit.
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

/// A vector value representing a span in a buffer. Unlike the
/// Range type, whose two positions are absolutes, a Distance
/// is meant to be used relative to a Position.
#[derive(Clone, Copy, Debug, PartialEq)]
pub struct Distance {
    pub lines: usize,
    pub offset: usize,
}

impl Distance {
    /// Calculates the distance covered by a string. The
    /// offset is calculated from the last line of the string.
    ///
    /// # Examples
    ///
    /// ```
    /// use scribe::buffer::Distance;
    ///
    /// let data = "scribe\ndistance";
    /// assert_eq!(Distance::of_str(data), Distance{
    ///     lines: 1,
    ///     offset: 8
    /// });
    /// ```
    pub fn of_str(from: &str) -> Distance {
        Distance {
            lines: from.chars().filter(|&c| c == '\n').count(),
            offset: from.split('\n').last().map(|l| l.len()).unwrap_or(0),
        }
    }
}

#[cfg(test)]
mod tests {
    use super::Distance;

    #[test]
    fn of_str_works_with_a_single_line_of_data() {
        assert_eq!(
            Distance::of_str("line"),
            Distance {
                lines: 0,
                offset: 4
            }
        );
    }

    #[test]
    fn of_str_works_with_a_trailing_newline() {
        assert_eq!(
            Distance::of_str("trailing newline\n"),
            Distance {
                lines: 1,
                offset: 0
            }
        );
    }
}