lines-inclusive 0.0.0

Split a string into multiple lines, every line may end with ` `
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

#![no_std]
#![doc = include_str!("specs.md")]

use core::{iter::FusedIterator, str::SplitInclusive};

mod sealed {
    pub trait Sealed {}
    impl Sealed for str {}
}

/// Extension trait that provides `lines_inclusive` method for `str`.
pub trait LinesInclusive: sealed::Sealed {
    /// Split a string into multiple lines, every line may end with `\n`.
    ///
    /// Note that if a line ends with `\n\r`, the `\r` will be the first character of the next line.
    fn lines_inclusive(&self) -> LinesInclusiveIter<'_>;
}

impl LinesInclusive for str {
    fn lines_inclusive(&self) -> LinesInclusiveIter<'_> {
        LinesInclusiveIter::new(self)
    }
}

/// Iterator over inclusive lines of strings.
///
/// This struct is created by calling [`LinesInclusive::lines_inclusive`].
#[derive(Debug, Clone)]
pub struct LinesInclusiveIter<'a>(SplitInclusive<'a, char>);

impl<'a> LinesInclusiveIter<'a> {
    /// Like [`LinesInclusive::lines_inclusive`].
    fn new(text: &'a str) -> Self {
        LinesInclusiveIter(text.split_inclusive('\n'))
    }
}

impl<'a> Iterator for LinesInclusiveIter<'a> {
    type Item = &'a str;
    fn next(&mut self) -> Option<Self::Item> {
        self.0.next()
    }
}

impl DoubleEndedIterator for LinesInclusiveIter<'_> {
    fn next_back(&mut self) -> Option<Self::Item> {
        self.0.next_back()
    }
}

impl FusedIterator for LinesInclusiveIter<'_> {}

#[doc = include_str!("README.md")]
mod test_readme {}