cargo-insert-docs 1.6.0

Inserts feature docs into crate docs, and crate docs into README.
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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

#[cfg(test)]
mod tests;

use core::ops::Range;
use std::borrow::Cow;

macro_rules! assert_le {
    ($left:expr, $right:expr) => {
        match (&$left, &$right) {
            (left, right) => {
                if !(left <= right) {
                    panic!(
                        "assertion `{left_expr} <= {right_expr}` failed\n  left: {left:?}\n right: {right:?}",
                        left_expr = stringify!($left),
                        right_expr = stringify!($right),
                    )
                }
            }
        }
    };
}

/// A type to efficiently replace string ranges.
///
/// Ranges and indices must be removed in order and must not overlap.
#[derive(Debug)]
pub struct StringReplacer<'a> {
    start: usize,
    string: &'a str,
    chunks: Vec<Cow<'a, str>>,
}

impl<'a> StringReplacer<'a> {
    pub fn new(string: &'a str) -> Self {
        Self { start: string.as_ptr().addr(), string, chunks: Vec::new() }
    }

    pub fn position(&self) -> usize {
        self.string.as_ptr().addr() - self.start
    }

    #[expect(dead_code)]
    pub fn rest(&self) -> &str {
        self.string
    }

    pub fn replace(&mut self, range: Range<usize>, with: impl Into<Cow<'a, str>>) {
        self.replace_inner(range, with.into())
    }

    pub fn insert(&mut self, idx: usize, with: impl Into<Cow<'a, str>>) {
        self.replace(idx..idx, with)
    }

    pub fn remove(&mut self, range: Range<usize>) {
        self.replace(range, "")
    }

    fn replace_inner(&mut self, mut range: Range<usize>, with: Cow<'a, str>) {
        let offset = self.position();

        if range.start < offset {
            panic!("tried to replace string out of order pos={offset:?} range={range:?}");
        }

        range.start -= offset;
        range.end -= offset;

        assert_le!(range.start, range.end);
        assert_le!(range.end, self.string.len());

        let start_chunk = &self.string[..range.start];

        if !start_chunk.is_empty() {
            self.chunks.push(Cow::Borrowed(start_chunk));
        }

        if !with.is_empty() {
            self.chunks.push(with);
        }

        self.string = &self.string[range.end..];
    }

    pub fn finish(&self) -> String {
        let mut cap = self.string.len();
        self.chunks.iter().for_each(|c: &Cow<'_, str>| cap += c.len());

        let mut out = String::with_capacity(cap);
        self.chunks.iter().for_each(|c| out.push_str(c));
        out.push_str(self.string);
        out
    }
}