| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `crates/rust-analyzer/src/line_index.rs`."><title>line_index.rs - source</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-77263533.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="rust_analyzer" data-themes="" data-resource-suffix="" data-rustdoc-version="1.94.0 (4a4ef493e 2026-03-02)" data-channel="1.94.0" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-b897f86f.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../../static.files/src-script-813739b1.js"></script><script defer src="../../src-files.js"></script><script defer src="../../static.files/main-7bab91a1.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-ffcac47a.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc src"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="src-sidebar-title"><h2>Files</h2></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><section id="main-content" class="content"><div class="main-heading"><h1><div class="sub-heading">rust_analyzer/</div>line_index.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-3"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! Enhances `ide::LineIndex` with additional info required to convert offsets |
| <a href=#2 id=2 data-nosnippet>2</a>//! into lsp positions. |
| <a href=#3 id=3 data-nosnippet>3</a>//! |
| <a href=#4 id=4 data-nosnippet>4</a>//! We maintain invariant that all internal strings use `\n` as line separator. |
| <a href=#5 id=5 data-nosnippet>5</a>//! This module does line ending conversion and detection (so that we can |
| <a href=#6 id=6 data-nosnippet>6</a>//! convert back to `\r\n` on the way out). |
| <a href=#7 id=7 data-nosnippet>7</a> |
| <a href=#8 id=8 data-nosnippet>8</a></span><span class="kw">use </span>ide_db::line_index::WideEncoding; |
| <a href=#9 id=9 data-nosnippet>9</a><span class="kw">use </span>memchr::memmem; |
| <a href=#10 id=10 data-nosnippet>10</a><span class="kw">use </span>triomphe::Arc; |
| <a href=#11 id=11 data-nosnippet>11</a> |
| <a href=#12 id=12 data-nosnippet>12</a><span class="attr">#[derive(Clone, Copy)] |
| <a href=#13 id=13 data-nosnippet>13</a></span><span class="kw">pub enum </span>PositionEncoding { |
| <a href=#14 id=14 data-nosnippet>14</a> Utf8, |
| <a href=#15 id=15 data-nosnippet>15</a> Wide(WideEncoding), |
| <a href=#16 id=16 data-nosnippet>16</a>} |
| <a href=#17 id=17 data-nosnippet>17</a> |
| <a href=#18 id=18 data-nosnippet>18</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">struct </span>LineIndex { |
| <a href=#19 id=19 data-nosnippet>19</a> <span class="kw">pub</span>(<span class="kw">crate</span>) index: Arc<ide::LineIndex>, |
| <a href=#20 id=20 data-nosnippet>20</a> <span class="kw">pub</span>(<span class="kw">crate</span>) endings: LineEndings, |
| <a href=#21 id=21 data-nosnippet>21</a> <span class="kw">pub</span>(<span class="kw">crate</span>) encoding: PositionEncoding, |
| <a href=#22 id=22 data-nosnippet>22</a>} |
| <a href=#23 id=23 data-nosnippet>23</a> |
| <a href=#24 id=24 data-nosnippet>24</a><span class="attr">#[derive(Debug, Clone, Copy, PartialEq, Eq, PartialOrd, Ord, Hash)] |
| <a href=#25 id=25 data-nosnippet>25</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">enum </span>LineEndings { |
| <a href=#26 id=26 data-nosnippet>26</a> Unix, |
| <a href=#27 id=27 data-nosnippet>27</a> Dos, |
| <a href=#28 id=28 data-nosnippet>28</a>} |
| <a href=#29 id=29 data-nosnippet>29</a> |
| <a href=#30 id=30 data-nosnippet>30</a><span class="kw">impl </span>LineEndings { |
| <a href=#31 id=31 data-nosnippet>31</a> <span class="doccomment">/// Replaces `\r\n` with `\n` in-place in `src`. |
| <a href=#32 id=32 data-nosnippet>32</a> </span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>normalize(src: String) -> (String, LineEndings) { |
| <a href=#33 id=33 data-nosnippet>33</a> <span class="comment">// We replace `\r\n` with `\n` in-place, which doesn't break utf-8 encoding. |
| <a href=#34 id=34 data-nosnippet>34</a> // While we *can* call `as_mut_vec` and do surgery on the live string |
| <a href=#35 id=35 data-nosnippet>35</a> // directly, let's rather steal the contents of `src`. This makes the code |
| <a href=#36 id=36 data-nosnippet>36</a> // safe even if a panic occurs. |
| <a href=#37 id=37 data-nosnippet>37</a> |
| <a href=#38 id=38 data-nosnippet>38</a> </span><span class="kw">let </span><span class="kw-2">mut </span>buf = src.into_bytes(); |
| <a href=#39 id=39 data-nosnippet>39</a> <span class="kw">let </span><span class="kw-2">mut </span>gap_len = <span class="number">0</span>; |
| <a href=#40 id=40 data-nosnippet>40</a> <span class="kw">let </span><span class="kw-2">mut </span>tail = buf.as_mut_slice(); |
| <a href=#41 id=41 data-nosnippet>41</a> <span class="kw">let </span><span class="kw-2">mut </span>crlf_seen = <span class="bool-val">false</span>; |
| <a href=#42 id=42 data-nosnippet>42</a> |
| <a href=#43 id=43 data-nosnippet>43</a> <span class="kw">let </span>finder = memmem::Finder::new(<span class="string">b"\r\n"</span>); |
| <a href=#44 id=44 data-nosnippet>44</a> |
| <a href=#45 id=45 data-nosnippet>45</a> <span class="kw">loop </span>{ |
| <a href=#46 id=46 data-nosnippet>46</a> <span class="kw">let </span>idx = <span class="kw">match </span>finder.find(<span class="kw-2">&</span>tail[gap_len..]) { |
| <a href=#47 id=47 data-nosnippet>47</a> <span class="prelude-val">None </span><span class="kw">if </span>crlf_seen => tail.len(), |
| <a href=#48 id=48 data-nosnippet>48</a> <span class="comment">// SAFETY: buf is unchanged and therefore still contains utf8 data |
| <a href=#49 id=49 data-nosnippet>49</a> </span><span class="prelude-val">None </span>=> <span class="kw">return </span>(<span class="kw">unsafe </span>{ String::from_utf8_unchecked(buf) }, LineEndings::Unix), |
| <a href=#50 id=50 data-nosnippet>50</a> <span class="prelude-val">Some</span>(idx) => { |
| <a href=#51 id=51 data-nosnippet>51</a> crlf_seen = <span class="bool-val">true</span>; |
| <a href=#52 id=52 data-nosnippet>52</a> idx + gap_len |
| <a href=#53 id=53 data-nosnippet>53</a> } |
| <a href=#54 id=54 data-nosnippet>54</a> }; |
| <a href=#55 id=55 data-nosnippet>55</a> tail.copy_within(gap_len..idx, <span class="number">0</span>); |
| <a href=#56 id=56 data-nosnippet>56</a> tail = <span class="kw-2">&mut </span>tail[idx - gap_len..]; |
| <a href=#57 id=57 data-nosnippet>57</a> <span class="kw">if </span>tail.len() == gap_len { |
| <a href=#58 id=58 data-nosnippet>58</a> <span class="kw">break</span>; |
| <a href=#59 id=59 data-nosnippet>59</a> } |
| <a href=#60 id=60 data-nosnippet>60</a> gap_len += <span class="number">1</span>; |
| <a href=#61 id=61 data-nosnippet>61</a> } |
| <a href=#62 id=62 data-nosnippet>62</a> |
| <a href=#63 id=63 data-nosnippet>63</a> <span class="comment">// Account for removed `\r`. |
| <a href=#64 id=64 data-nosnippet>64</a> // After `set_len`, `buf` is guaranteed to contain utf-8 again. |
| <a href=#65 id=65 data-nosnippet>65</a> </span><span class="kw">let </span>new_len = buf.len() - gap_len; |
| <a href=#66 id=66 data-nosnippet>66</a> <span class="kw">let </span>src = <span class="kw">unsafe </span>{ |
| <a href=#67 id=67 data-nosnippet>67</a> buf.set_len(new_len); |
| <a href=#68 id=68 data-nosnippet>68</a> String::from_utf8_unchecked(buf) |
| <a href=#69 id=69 data-nosnippet>69</a> }; |
| <a href=#70 id=70 data-nosnippet>70</a> (src, LineEndings::Dos) |
| <a href=#71 id=71 data-nosnippet>71</a> } |
| <a href=#72 id=72 data-nosnippet>72</a>} |
| <a href=#73 id=73 data-nosnippet>73</a> |
| <a href=#74 id=74 data-nosnippet>74</a><span class="attr">#[cfg(test)] |
| <a href=#75 id=75 data-nosnippet>75</a></span><span class="kw">mod </span>tests { |
| <a href=#76 id=76 data-nosnippet>76</a> <span class="kw">use </span>super::<span class="kw-2">*</span>; |
| <a href=#77 id=77 data-nosnippet>77</a> |
| <a href=#78 id=78 data-nosnippet>78</a> <span class="attr">#[test] |
| <a href=#79 id=79 data-nosnippet>79</a> </span><span class="kw">fn </span>unix() { |
| <a href=#80 id=80 data-nosnippet>80</a> <span class="kw">let </span>src = <span class="string">"a\nb\nc\n\n\n\n"</span>; |
| <a href=#81 id=81 data-nosnippet>81</a> <span class="kw">let </span>(res, endings) = LineEndings::normalize(src.into()); |
| <a href=#82 id=82 data-nosnippet>82</a> <span class="macro">assert_eq!</span>(endings, LineEndings::Unix); |
| <a href=#83 id=83 data-nosnippet>83</a> <span class="macro">assert_eq!</span>(res, src); |
| <a href=#84 id=84 data-nosnippet>84</a> } |
| <a href=#85 id=85 data-nosnippet>85</a> |
| <a href=#86 id=86 data-nosnippet>86</a> <span class="attr">#[test] |
| <a href=#87 id=87 data-nosnippet>87</a> </span><span class="kw">fn </span>dos() { |
| <a href=#88 id=88 data-nosnippet>88</a> <span class="kw">let </span>src = <span class="string">"\r\na\r\n\r\nb\r\nc\r\n\r\n\r\n\r\n"</span>; |
| <a href=#89 id=89 data-nosnippet>89</a> <span class="kw">let </span>(res, endings) = LineEndings::normalize(src.into()); |
| <a href=#90 id=90 data-nosnippet>90</a> <span class="macro">assert_eq!</span>(endings, LineEndings::Dos); |
| <a href=#91 id=91 data-nosnippet>91</a> <span class="macro">assert_eq!</span>(res, <span class="string">"\na\n\nb\nc\n\n\n\n"</span>); |
| <a href=#92 id=92 data-nosnippet>92</a> } |
| <a href=#93 id=93 data-nosnippet>93</a> |
| <a href=#94 id=94 data-nosnippet>94</a> <span class="attr">#[test] |
| <a href=#95 id=95 data-nosnippet>95</a> </span><span class="kw">fn </span>mixed() { |
| <a href=#96 id=96 data-nosnippet>96</a> <span class="kw">let </span>src = <span class="string">"a\r\nb\r\nc\r\n\n\r\n\n"</span>; |
| <a href=#97 id=97 data-nosnippet>97</a> <span class="kw">let </span>(res, endings) = LineEndings::normalize(src.into()); |
| <a href=#98 id=98 data-nosnippet>98</a> <span class="macro">assert_eq!</span>(endings, LineEndings::Dos); |
| <a href=#99 id=99 data-nosnippet>99</a> <span class="macro">assert_eq!</span>(res, <span class="string">"a\nb\nc\n\n\n\n"</span>); |
| <a href=#100 id=100 data-nosnippet>100</a> } |
| <a href=#101 id=101 data-nosnippet>101</a> |
| <a href=#102 id=102 data-nosnippet>102</a> <span class="attr">#[test] |
| <a href=#103 id=103 data-nosnippet>103</a> </span><span class="kw">fn </span>none() { |
| <a href=#104 id=104 data-nosnippet>104</a> <span class="kw">let </span>src = <span class="string">"abc"</span>; |
| <a href=#105 id=105 data-nosnippet>105</a> <span class="kw">let </span>(res, endings) = LineEndings::normalize(src.into()); |
| <a href=#106 id=106 data-nosnippet>106</a> <span class="macro">assert_eq!</span>(endings, LineEndings::Unix); |
| <a href=#107 id=107 data-nosnippet>107</a> <span class="macro">assert_eq!</span>(res, src); |
| <a href=#108 id=108 data-nosnippet>108</a> } |
| <a href=#109 id=109 data-nosnippet>109</a>} |
| </code></pre></div></section></main></body></html> |
