| <!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/parser/src/frontmatter.rs`."><title>frontmatter.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-e56847b5.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="parser" data-themes="" data-resource-suffix="" data-rustdoc-version="1.91.0 (f8297e351 2025-10-28)" data-channel="1.91.0" data-search-js="search-e256b49e.js" data-stringdex-js="stringdex-c3e638e9.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-6dc2a7f3.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.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">parser/</div>frontmatter.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="comment">// Copied from https://github.com/rust-lang/cargo/blob/367fd9f213750cd40317803dd0a5a3ce3f0c676d/src/cargo/util/frontmatter.rs |
| <a href=#2 id=2 data-nosnippet>2</a></span><span class="attr">#![expect(dead_code)] </span><span class="comment">// avoid editing |
| <a href=#3 id=3 data-nosnippet>3</a></span><span class="attr">#![expect(unreachable_pub)] </span><span class="comment">// avoid editing |
| <a href=#4 id=4 data-nosnippet>4</a></span><span class="attr">#![expect(clippy::useless_format)] </span><span class="comment">// avoid editing |
| <a href=#5 id=5 data-nosnippet>5</a> |
| <a href=#6 id=6 data-nosnippet>6</a></span><span class="kw">type </span>Span = std::ops::Range<usize>; |
| <a href=#7 id=7 data-nosnippet>7</a> |
| <a href=#8 id=8 data-nosnippet>8</a><span class="attr">#[derive(Debug)] |
| <a href=#9 id=9 data-nosnippet>9</a></span><span class="kw">pub struct </span>ScriptSource<<span class="lifetime">'s</span>> { |
| <a href=#10 id=10 data-nosnippet>10</a> <span class="doccomment">/// The full file |
| <a href=#11 id=11 data-nosnippet>11</a> </span>raw: <span class="kw-2">&</span><span class="lifetime">'s </span>str, |
| <a href=#12 id=12 data-nosnippet>12</a> <span class="doccomment">/// The `#!/usr/bin/env cargo` line, if present |
| <a href=#13 id=13 data-nosnippet>13</a> </span>shebang: <span class="prelude-ty">Option</span><Span>, |
| <a href=#14 id=14 data-nosnippet>14</a> <span class="doccomment">/// The code fence opener (`---`) |
| <a href=#15 id=15 data-nosnippet>15</a> </span>open: <span class="prelude-ty">Option</span><Span>, |
| <a href=#16 id=16 data-nosnippet>16</a> <span class="doccomment">/// Trailing text after `ScriptSource::open` that identifies the meaning of |
| <a href=#17 id=17 data-nosnippet>17</a> /// `ScriptSource::frontmatter` |
| <a href=#18 id=18 data-nosnippet>18</a> </span>info: <span class="prelude-ty">Option</span><Span>, |
| <a href=#19 id=19 data-nosnippet>19</a> <span class="doccomment">/// The lines between `ScriptSource::open` and `ScriptSource::close` |
| <a href=#20 id=20 data-nosnippet>20</a> </span>frontmatter: <span class="prelude-ty">Option</span><Span>, |
| <a href=#21 id=21 data-nosnippet>21</a> <span class="doccomment">/// The code fence closer (`---`) |
| <a href=#22 id=22 data-nosnippet>22</a> </span>close: <span class="prelude-ty">Option</span><Span>, |
| <a href=#23 id=23 data-nosnippet>23</a> <span class="doccomment">/// All content after the frontmatter and shebang |
| <a href=#24 id=24 data-nosnippet>24</a> </span>content: Span, |
| <a href=#25 id=25 data-nosnippet>25</a>} |
| <a href=#26 id=26 data-nosnippet>26</a> |
| <a href=#27 id=27 data-nosnippet>27</a><span class="kw">impl</span><<span class="lifetime">'s</span>> ScriptSource<<span class="lifetime">'s</span>> { |
| <a href=#28 id=28 data-nosnippet>28</a> <span class="kw">pub fn </span>parse(raw: <span class="kw-2">&</span><span class="lifetime">'s </span>str) -> <span class="prelude-ty">Result</span><<span class="self">Self</span>, FrontmatterError> { |
| <a href=#29 id=29 data-nosnippet>29</a> <span class="kw">use </span>winnow::stream::FindSlice <span class="kw">as _</span>; |
| <a href=#30 id=30 data-nosnippet>30</a> <span class="kw">use </span>winnow::stream::Location <span class="kw">as _</span>; |
| <a href=#31 id=31 data-nosnippet>31</a> <span class="kw">use </span>winnow::stream::Offset <span class="kw">as _</span>; |
| <a href=#32 id=32 data-nosnippet>32</a> <span class="kw">use </span>winnow::stream::Stream <span class="kw">as _</span>; |
| <a href=#33 id=33 data-nosnippet>33</a> |
| <a href=#34 id=34 data-nosnippet>34</a> <span class="kw">let </span>content_end = raw.len(); |
| <a href=#35 id=35 data-nosnippet>35</a> <span class="kw">let </span><span class="kw-2">mut </span>source = <span class="self">Self </span>{ |
| <a href=#36 id=36 data-nosnippet>36</a> raw, |
| <a href=#37 id=37 data-nosnippet>37</a> shebang: <span class="prelude-val">None</span>, |
| <a href=#38 id=38 data-nosnippet>38</a> open: <span class="prelude-val">None</span>, |
| <a href=#39 id=39 data-nosnippet>39</a> info: <span class="prelude-val">None</span>, |
| <a href=#40 id=40 data-nosnippet>40</a> frontmatter: <span class="prelude-val">None</span>, |
| <a href=#41 id=41 data-nosnippet>41</a> close: <span class="prelude-val">None</span>, |
| <a href=#42 id=42 data-nosnippet>42</a> content: <span class="number">0</span>..content_end, |
| <a href=#43 id=43 data-nosnippet>43</a> }; |
| <a href=#44 id=44 data-nosnippet>44</a> |
| <a href=#45 id=45 data-nosnippet>45</a> <span class="kw">let </span><span class="kw-2">mut </span>input = winnow::stream::LocatingSlice::new(raw); |
| <a href=#46 id=46 data-nosnippet>46</a> |
| <a href=#47 id=47 data-nosnippet>47</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(shebang_end) = strip_shebang(input.as_ref()) { |
| <a href=#48 id=48 data-nosnippet>48</a> <span class="kw">let </span>shebang_start = input.current_token_start(); |
| <a href=#49 id=49 data-nosnippet>49</a> <span class="kw">let _ </span>= input.next_slice(shebang_end); |
| <a href=#50 id=50 data-nosnippet>50</a> <span class="kw">let </span>shebang_end = input.current_token_start(); |
| <a href=#51 id=51 data-nosnippet>51</a> source.shebang = <span class="prelude-val">Some</span>(shebang_start..shebang_end); |
| <a href=#52 id=52 data-nosnippet>52</a> source.content = shebang_end..content_end; |
| <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> <span class="comment">// Whitespace may precede a frontmatter but must end with a newline |
| <a href=#56 id=56 data-nosnippet>56</a> </span><span class="kw">if let </span><span class="prelude-val">Some</span>(nl_end) = strip_ws_lines(input.as_ref()) { |
| <a href=#57 id=57 data-nosnippet>57</a> <span class="kw">let _ </span>= input.next_slice(nl_end); |
| <a href=#58 id=58 data-nosnippet>58</a> } |
| <a href=#59 id=59 data-nosnippet>59</a> |
| <a href=#60 id=60 data-nosnippet>60</a> <span class="comment">// Opens with a line that starts with 3 or more `-` followed by an optional identifier |
| <a href=#61 id=61 data-nosnippet>61</a> </span><span class="kw">const </span>FENCE_CHAR: char = <span class="string">'-'</span>; |
| <a href=#62 id=62 data-nosnippet>62</a> <span class="kw">let </span>fence_length = input |
| <a href=#63 id=63 data-nosnippet>63</a> .as_ref() |
| <a href=#64 id=64 data-nosnippet>64</a> .char_indices() |
| <a href=#65 id=65 data-nosnippet>65</a> .find_map(|(i, c)| (c != FENCE_CHAR).then_some(i)) |
| <a href=#66 id=66 data-nosnippet>66</a> .unwrap_or_else(|| input.eof_offset()); |
| <a href=#67 id=67 data-nosnippet>67</a> <span class="kw">let </span>open_start = input.current_token_start(); |
| <a href=#68 id=68 data-nosnippet>68</a> <span class="kw">let </span>fence_pattern = input.next_slice(fence_length); |
| <a href=#69 id=69 data-nosnippet>69</a> <span class="kw">let </span>open_end = input.current_token_start(); |
| <a href=#70 id=70 data-nosnippet>70</a> <span class="kw">match </span>fence_length { |
| <a href=#71 id=71 data-nosnippet>71</a> <span class="number">0 </span>=> { |
| <a href=#72 id=72 data-nosnippet>72</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(source); |
| <a href=#73 id=73 data-nosnippet>73</a> } |
| <a href=#74 id=74 data-nosnippet>74</a> <span class="number">1 </span>| <span class="number">2 </span>=> { |
| <a href=#75 id=75 data-nosnippet>75</a> <span class="comment">// either not a frontmatter or invalid frontmatter opening |
| <a href=#76 id=76 data-nosnippet>76</a> </span><span class="kw">return </span><span class="prelude-val">Err</span>(FrontmatterError::new( |
| <a href=#77 id=77 data-nosnippet>77</a> <span class="macro">format!</span>( |
| <a href=#78 id=78 data-nosnippet>78</a> <span class="string">"found {fence_length} `{FENCE_CHAR}` in rust frontmatter, expected at least 3" |
| <a href=#79 id=79 data-nosnippet>79</a> </span>), |
| <a href=#80 id=80 data-nosnippet>80</a> raw.len()..raw.len(), |
| <a href=#81 id=81 data-nosnippet>81</a> ).push_visible_span(open_start..open_end)); |
| <a href=#82 id=82 data-nosnippet>82</a> } |
| <a href=#83 id=83 data-nosnippet>83</a> <span class="kw">_ </span>=> {} |
| <a href=#84 id=84 data-nosnippet>84</a> } |
| <a href=#85 id=85 data-nosnippet>85</a> source.open = <span class="prelude-val">Some</span>(open_start..open_end); |
| <a href=#86 id=86 data-nosnippet>86</a> <span class="kw">let </span><span class="prelude-val">Some</span>(info_nl) = input.find_slice(<span class="string">"\n"</span>) <span class="kw">else </span>{ |
| <a href=#87 id=87 data-nosnippet>87</a> <span class="kw">return </span><span class="prelude-val">Err</span>(FrontmatterError::new( |
| <a href=#88 id=88 data-nosnippet>88</a> <span class="macro">format!</span>(<span class="string">"unclosed frontmatter; expected `{fence_pattern}`"</span>), |
| <a href=#89 id=89 data-nosnippet>89</a> raw.len()..raw.len(), |
| <a href=#90 id=90 data-nosnippet>90</a> ) |
| <a href=#91 id=91 data-nosnippet>91</a> .push_visible_span(open_start..open_end)); |
| <a href=#92 id=92 data-nosnippet>92</a> }; |
| <a href=#93 id=93 data-nosnippet>93</a> <span class="kw">let </span>info = input.next_slice(info_nl.start); |
| <a href=#94 id=94 data-nosnippet>94</a> <span class="kw">let </span>info = info.strip_suffix(<span class="string">'\r'</span>).unwrap_or(info); <span class="comment">// already excludes `\n` |
| <a href=#95 id=95 data-nosnippet>95</a> </span><span class="kw">let </span>info = info.trim_matches(is_horizontal_whitespace); |
| <a href=#96 id=96 data-nosnippet>96</a> <span class="kw">if </span>!info.is_empty() { |
| <a href=#97 id=97 data-nosnippet>97</a> <span class="kw">let </span>info_start = info.offset_from(<span class="kw-2">&</span>raw); |
| <a href=#98 id=98 data-nosnippet>98</a> <span class="kw">let </span>info_end = info_start + info.len(); |
| <a href=#99 id=99 data-nosnippet>99</a> source.info = <span class="prelude-val">Some</span>(info_start..info_end); |
| <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="comment">// Ends with a line that starts with a matching number of `-` only followed by whitespace |
| <a href=#103 id=103 data-nosnippet>103</a> </span><span class="kw">let </span>nl_fence_pattern = <span class="macro">format!</span>(<span class="string">"\n{fence_pattern}"</span>); |
| <a href=#104 id=104 data-nosnippet>104</a> <span class="kw">let </span><span class="prelude-val">Some</span>(frontmatter_nl) = input.find_slice(nl_fence_pattern.as_str()) <span class="kw">else </span>{ |
| <a href=#105 id=105 data-nosnippet>105</a> <span class="kw">for </span>len <span class="kw">in </span>(<span class="number">2</span>..(nl_fence_pattern.len() - <span class="number">1</span>)).rev() { |
| <a href=#106 id=106 data-nosnippet>106</a> <span class="kw">let </span><span class="prelude-val">Some</span>(frontmatter_nl) = input.find_slice(<span class="kw-2">&</span>nl_fence_pattern[<span class="number">0</span>..len]) <span class="kw">else </span>{ |
| <a href=#107 id=107 data-nosnippet>107</a> <span class="kw">continue</span>; |
| <a href=#108 id=108 data-nosnippet>108</a> }; |
| <a href=#109 id=109 data-nosnippet>109</a> <span class="kw">let _ </span>= input.next_slice(frontmatter_nl.start + <span class="number">1</span>); |
| <a href=#110 id=110 data-nosnippet>110</a> <span class="kw">let </span>close_start = input.current_token_start(); |
| <a href=#111 id=111 data-nosnippet>111</a> <span class="kw">let _ </span>= input.next_slice(len); |
| <a href=#112 id=112 data-nosnippet>112</a> <span class="kw">let </span>close_end = input.current_token_start(); |
| <a href=#113 id=113 data-nosnippet>113</a> <span class="kw">let </span>fewer_dashes = fence_length - len; |
| <a href=#114 id=114 data-nosnippet>114</a> <span class="kw">return </span><span class="prelude-val">Err</span>(FrontmatterError::new( |
| <a href=#115 id=115 data-nosnippet>115</a> <span class="macro">format!</span>( |
| <a href=#116 id=116 data-nosnippet>116</a> <span class="string">"closing code fence has {fewer_dashes} less `-` than the opening fence" |
| <a href=#117 id=117 data-nosnippet>117</a> </span>), |
| <a href=#118 id=118 data-nosnippet>118</a> close_start..close_end, |
| <a href=#119 id=119 data-nosnippet>119</a> ) |
| <a href=#120 id=120 data-nosnippet>120</a> .push_visible_span(open_start..open_end)); |
| <a href=#121 id=121 data-nosnippet>121</a> } |
| <a href=#122 id=122 data-nosnippet>122</a> <span class="kw">return </span><span class="prelude-val">Err</span>(FrontmatterError::new( |
| <a href=#123 id=123 data-nosnippet>123</a> <span class="macro">format!</span>(<span class="string">"unclosed frontmatter; expected `{fence_pattern}`"</span>), |
| <a href=#124 id=124 data-nosnippet>124</a> raw.len()..raw.len(), |
| <a href=#125 id=125 data-nosnippet>125</a> ) |
| <a href=#126 id=126 data-nosnippet>126</a> .push_visible_span(open_start..open_end)); |
| <a href=#127 id=127 data-nosnippet>127</a> }; |
| <a href=#128 id=128 data-nosnippet>128</a> <span class="kw">let </span>frontmatter_start = input.current_token_start() + <span class="number">1</span>; <span class="comment">// skip nl from infostring |
| <a href=#129 id=129 data-nosnippet>129</a> </span><span class="kw">let _ </span>= input.next_slice(frontmatter_nl.start + <span class="number">1</span>); |
| <a href=#130 id=130 data-nosnippet>130</a> <span class="kw">let </span>frontmatter_end = input.current_token_start(); |
| <a href=#131 id=131 data-nosnippet>131</a> source.frontmatter = <span class="prelude-val">Some</span>(frontmatter_start..frontmatter_end); |
| <a href=#132 id=132 data-nosnippet>132</a> <span class="kw">let </span>close_start = input.current_token_start(); |
| <a href=#133 id=133 data-nosnippet>133</a> <span class="kw">let _ </span>= input.next_slice(fence_length); |
| <a href=#134 id=134 data-nosnippet>134</a> <span class="kw">let </span>close_end = input.current_token_start(); |
| <a href=#135 id=135 data-nosnippet>135</a> source.close = <span class="prelude-val">Some</span>(close_start..close_end); |
| <a href=#136 id=136 data-nosnippet>136</a> |
| <a href=#137 id=137 data-nosnippet>137</a> <span class="kw">let </span>nl = input.find_slice(<span class="string">"\n"</span>); |
| <a href=#138 id=138 data-nosnippet>138</a> <span class="kw">let </span>after_closing_fence = |
| <a href=#139 id=139 data-nosnippet>139</a> input.next_slice(nl.map(|span| span.end).unwrap_or_else(|| input.eof_offset())); |
| <a href=#140 id=140 data-nosnippet>140</a> <span class="kw">let </span>content_start = input.current_token_start(); |
| <a href=#141 id=141 data-nosnippet>141</a> <span class="kw">let </span>extra_dashes = after_closing_fence.chars().take_while(|b| <span class="kw-2">*</span>b == FENCE_CHAR).count(); |
| <a href=#142 id=142 data-nosnippet>142</a> <span class="kw">if </span><span class="number">0 </span>< extra_dashes { |
| <a href=#143 id=143 data-nosnippet>143</a> <span class="kw">let </span>extra_start = close_end; |
| <a href=#144 id=144 data-nosnippet>144</a> <span class="kw">let </span>extra_end = extra_start + extra_dashes; |
| <a href=#145 id=145 data-nosnippet>145</a> <span class="kw">return </span><span class="prelude-val">Err</span>(FrontmatterError::new( |
| <a href=#146 id=146 data-nosnippet>146</a> <span class="macro">format!</span>(<span class="string">"closing code fence has {extra_dashes} more `-` than the opening fence"</span>), |
| <a href=#147 id=147 data-nosnippet>147</a> extra_start..extra_end, |
| <a href=#148 id=148 data-nosnippet>148</a> ) |
| <a href=#149 id=149 data-nosnippet>149</a> .push_visible_span(open_start..open_end)); |
| <a href=#150 id=150 data-nosnippet>150</a> } <span class="kw">else </span>{ |
| <a href=#151 id=151 data-nosnippet>151</a> <span class="kw">let </span>after_closing_fence = strip_newline(after_closing_fence); |
| <a href=#152 id=152 data-nosnippet>152</a> <span class="kw">let </span>after_closing_fence = after_closing_fence.trim_matches(is_horizontal_whitespace); |
| <a href=#153 id=153 data-nosnippet>153</a> <span class="kw">if </span>!after_closing_fence.is_empty() { |
| <a href=#154 id=154 data-nosnippet>154</a> <span class="comment">// extra characters beyond the original fence pattern |
| <a href=#155 id=155 data-nosnippet>155</a> </span><span class="kw">let </span>after_start = after_closing_fence.offset_from(<span class="kw-2">&</span>raw); |
| <a href=#156 id=156 data-nosnippet>156</a> <span class="kw">let </span>after_end = after_start + after_closing_fence.len(); |
| <a href=#157 id=157 data-nosnippet>157</a> <span class="kw">return </span><span class="prelude-val">Err</span>(FrontmatterError::new( |
| <a href=#158 id=158 data-nosnippet>158</a> <span class="macro">format!</span>(<span class="string">"unexpected characters after frontmatter close"</span>), |
| <a href=#159 id=159 data-nosnippet>159</a> after_start..after_end, |
| <a href=#160 id=160 data-nosnippet>160</a> ) |
| <a href=#161 id=161 data-nosnippet>161</a> .push_visible_span(open_start..open_end)); |
| <a href=#162 id=162 data-nosnippet>162</a> } |
| <a href=#163 id=163 data-nosnippet>163</a> } |
| <a href=#164 id=164 data-nosnippet>164</a> |
| <a href=#165 id=165 data-nosnippet>165</a> source.content = content_start..content_end; |
| <a href=#166 id=166 data-nosnippet>166</a> |
| <a href=#167 id=167 data-nosnippet>167</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(nl_end) = strip_ws_lines(input.as_ref()) { |
| <a href=#168 id=168 data-nosnippet>168</a> <span class="kw">let _ </span>= input.next_slice(nl_end); |
| <a href=#169 id=169 data-nosnippet>169</a> } |
| <a href=#170 id=170 data-nosnippet>170</a> <span class="kw">let </span>fence_length = input |
| <a href=#171 id=171 data-nosnippet>171</a> .as_ref() |
| <a href=#172 id=172 data-nosnippet>172</a> .char_indices() |
| <a href=#173 id=173 data-nosnippet>173</a> .find_map(|(i, c)| (c != FENCE_CHAR).then_some(i)) |
| <a href=#174 id=174 data-nosnippet>174</a> .unwrap_or_else(|| input.eof_offset()); |
| <a href=#175 id=175 data-nosnippet>175</a> <span class="kw">if </span><span class="number">0 </span>< fence_length { |
| <a href=#176 id=176 data-nosnippet>176</a> <span class="kw">let </span>fence_start = input.current_token_start(); |
| <a href=#177 id=177 data-nosnippet>177</a> <span class="kw">let </span>fence_end = fence_start + fence_length; |
| <a href=#178 id=178 data-nosnippet>178</a> <span class="kw">return </span><span class="prelude-val">Err</span>(FrontmatterError::new( |
| <a href=#179 id=179 data-nosnippet>179</a> <span class="macro">format!</span>(<span class="string">"only one frontmatter is supported"</span>), |
| <a href=#180 id=180 data-nosnippet>180</a> fence_start..fence_end, |
| <a href=#181 id=181 data-nosnippet>181</a> ) |
| <a href=#182 id=182 data-nosnippet>182</a> .push_visible_span(open_start..open_end) |
| <a href=#183 id=183 data-nosnippet>183</a> .push_visible_span(close_start..close_end)); |
| <a href=#184 id=184 data-nosnippet>184</a> } |
| <a href=#185 id=185 data-nosnippet>185</a> |
| <a href=#186 id=186 data-nosnippet>186</a> <span class="prelude-val">Ok</span>(source) |
| <a href=#187 id=187 data-nosnippet>187</a> } |
| <a href=#188 id=188 data-nosnippet>188</a> |
| <a href=#189 id=189 data-nosnippet>189</a> <span class="kw">pub fn </span>shebang(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'s </span>str> { |
| <a href=#190 id=190 data-nosnippet>190</a> <span class="self">self</span>.shebang.clone().map(|span| <span class="kw-2">&</span><span class="self">self</span>.raw[span]) |
| <a href=#191 id=191 data-nosnippet>191</a> } |
| <a href=#192 id=192 data-nosnippet>192</a> |
| <a href=#193 id=193 data-nosnippet>193</a> <span class="kw">pub fn </span>shebang_span(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><Span> { |
| <a href=#194 id=194 data-nosnippet>194</a> <span class="self">self</span>.shebang.clone() |
| <a href=#195 id=195 data-nosnippet>195</a> } |
| <a href=#196 id=196 data-nosnippet>196</a> |
| <a href=#197 id=197 data-nosnippet>197</a> <span class="kw">pub fn </span>open_span(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><Span> { |
| <a href=#198 id=198 data-nosnippet>198</a> <span class="self">self</span>.open.clone() |
| <a href=#199 id=199 data-nosnippet>199</a> } |
| <a href=#200 id=200 data-nosnippet>200</a> |
| <a href=#201 id=201 data-nosnippet>201</a> <span class="kw">pub fn </span>info(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'s </span>str> { |
| <a href=#202 id=202 data-nosnippet>202</a> <span class="self">self</span>.info.clone().map(|span| <span class="kw-2">&</span><span class="self">self</span>.raw[span]) |
| <a href=#203 id=203 data-nosnippet>203</a> } |
| <a href=#204 id=204 data-nosnippet>204</a> |
| <a href=#205 id=205 data-nosnippet>205</a> <span class="kw">pub fn </span>info_span(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><Span> { |
| <a href=#206 id=206 data-nosnippet>206</a> <span class="self">self</span>.info.clone() |
| <a href=#207 id=207 data-nosnippet>207</a> } |
| <a href=#208 id=208 data-nosnippet>208</a> |
| <a href=#209 id=209 data-nosnippet>209</a> <span class="kw">pub fn </span>frontmatter(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'s </span>str> { |
| <a href=#210 id=210 data-nosnippet>210</a> <span class="self">self</span>.frontmatter.clone().map(|span| <span class="kw-2">&</span><span class="self">self</span>.raw[span]) |
| <a href=#211 id=211 data-nosnippet>211</a> } |
| <a href=#212 id=212 data-nosnippet>212</a> |
| <a href=#213 id=213 data-nosnippet>213</a> <span class="kw">pub fn </span>frontmatter_span(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><Span> { |
| <a href=#214 id=214 data-nosnippet>214</a> <span class="self">self</span>.frontmatter.clone() |
| <a href=#215 id=215 data-nosnippet>215</a> } |
| <a href=#216 id=216 data-nosnippet>216</a> |
| <a href=#217 id=217 data-nosnippet>217</a> <span class="kw">pub fn </span>close_span(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><Span> { |
| <a href=#218 id=218 data-nosnippet>218</a> <span class="self">self</span>.close.clone() |
| <a href=#219 id=219 data-nosnippet>219</a> } |
| <a href=#220 id=220 data-nosnippet>220</a> |
| <a href=#221 id=221 data-nosnippet>221</a> <span class="kw">pub fn </span>content(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span><span class="lifetime">'s </span>str { |
| <a href=#222 id=222 data-nosnippet>222</a> <span class="kw-2">&</span><span class="self">self</span>.raw[<span class="self">self</span>.content.clone()] |
| <a href=#223 id=223 data-nosnippet>223</a> } |
| <a href=#224 id=224 data-nosnippet>224</a> |
| <a href=#225 id=225 data-nosnippet>225</a> <span class="kw">pub fn </span>content_span(<span class="kw-2">&</span><span class="self">self</span>) -> Span { |
| <a href=#226 id=226 data-nosnippet>226</a> <span class="self">self</span>.content.clone() |
| <a href=#227 id=227 data-nosnippet>227</a> } |
| <a href=#228 id=228 data-nosnippet>228</a>} |
| <a href=#229 id=229 data-nosnippet>229</a> |
| <a href=#230 id=230 data-nosnippet>230</a><span class="doccomment">/// Returns the index after the shebang line, if present |
| <a href=#231 id=231 data-nosnippet>231</a></span><span class="kw">pub fn </span>strip_shebang(input: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Option</span><usize> { |
| <a href=#232 id=232 data-nosnippet>232</a> <span class="comment">// See rust-lang/rust's compiler/rustc_lexer/src/lib.rs's `strip_shebang` |
| <a href=#233 id=233 data-nosnippet>233</a> // Shebang must start with `#!` literally, without any preceding whitespace. |
| <a href=#234 id=234 data-nosnippet>234</a> // For simplicity we consider any line starting with `#!` a shebang, |
| <a href=#235 id=235 data-nosnippet>235</a> // regardless of restrictions put on shebangs by specific platforms. |
| <a href=#236 id=236 data-nosnippet>236</a> </span><span class="kw">if let </span><span class="prelude-val">Some</span>(rest) = input.strip_prefix(<span class="string">"#!"</span>) { |
| <a href=#237 id=237 data-nosnippet>237</a> <span class="comment">// Ok, this is a shebang but if the next non-whitespace token is `[`, |
| <a href=#238 id=238 data-nosnippet>238</a> // then it may be valid Rust code, so consider it Rust code. |
| <a href=#239 id=239 data-nosnippet>239</a> // |
| <a href=#240 id=240 data-nosnippet>240</a> // NOTE: rustc considers line and block comments to be whitespace but to avoid |
| <a href=#241 id=241 data-nosnippet>241</a> // any more awareness of Rust grammar, we are excluding it. |
| <a href=#242 id=242 data-nosnippet>242</a> </span><span class="kw">if </span>!rest.trim_start().starts_with(<span class="string">'['</span>) { |
| <a href=#243 id=243 data-nosnippet>243</a> <span class="comment">// No other choice than to consider this a shebang. |
| <a href=#244 id=244 data-nosnippet>244</a> </span><span class="kw">let </span>newline_end = input.find(<span class="string">'\n'</span>).map(|pos| pos + <span class="number">1</span>).unwrap_or(input.len()); |
| <a href=#245 id=245 data-nosnippet>245</a> <span class="kw">return </span><span class="prelude-val">Some</span>(newline_end); |
| <a href=#246 id=246 data-nosnippet>246</a> } |
| <a href=#247 id=247 data-nosnippet>247</a> } |
| <a href=#248 id=248 data-nosnippet>248</a> <span class="prelude-val">None |
| <a href=#249 id=249 data-nosnippet>249</a></span>} |
| <a href=#250 id=250 data-nosnippet>250</a> |
| <a href=#251 id=251 data-nosnippet>251</a><span class="doccomment">/// Returns the index after any lines with only whitespace, if present |
| <a href=#252 id=252 data-nosnippet>252</a></span><span class="kw">pub fn </span>strip_ws_lines(input: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Option</span><usize> { |
| <a href=#253 id=253 data-nosnippet>253</a> <span class="kw">let </span>ws_end = input.find(|c| !is_whitespace(c)).unwrap_or(input.len()); |
| <a href=#254 id=254 data-nosnippet>254</a> <span class="kw">if </span>ws_end == <span class="number">0 </span>{ |
| <a href=#255 id=255 data-nosnippet>255</a> <span class="kw">return </span><span class="prelude-val">None</span>; |
| <a href=#256 id=256 data-nosnippet>256</a> } |
| <a href=#257 id=257 data-nosnippet>257</a> |
| <a href=#258 id=258 data-nosnippet>258</a> <span class="kw">let </span>nl_start = input[<span class="number">0</span>..ws_end].rfind(<span class="string">'\n'</span>)<span class="question-mark">?</span>; |
| <a href=#259 id=259 data-nosnippet>259</a> <span class="kw">let </span>nl_end = nl_start + <span class="number">1</span>; |
| <a href=#260 id=260 data-nosnippet>260</a> <span class="prelude-val">Some</span>(nl_end) |
| <a href=#261 id=261 data-nosnippet>261</a>} |
| <a href=#262 id=262 data-nosnippet>262</a> |
| <a href=#263 id=263 data-nosnippet>263</a><span class="doccomment">/// True if `c` is considered a whitespace according to Rust language definition. |
| <a href=#264 id=264 data-nosnippet>264</a>/// See [Rust language reference](https://doc.rust-lang.org/reference/whitespace.html) |
| <a href=#265 id=265 data-nosnippet>265</a>/// for definitions of these classes. |
| <a href=#266 id=266 data-nosnippet>266</a></span><span class="kw">fn </span>is_whitespace(c: char) -> bool { |
| <a href=#267 id=267 data-nosnippet>267</a> <span class="comment">// This is Pattern_White_Space. |
| <a href=#268 id=268 data-nosnippet>268</a> // |
| <a href=#269 id=269 data-nosnippet>269</a> // Note that this set is stable (ie, it doesn't change with different |
| <a href=#270 id=270 data-nosnippet>270</a> // Unicode versions), so it's ok to just hard-code the values. |
| <a href=#271 id=271 data-nosnippet>271</a> |
| <a href=#272 id=272 data-nosnippet>272</a> </span><span class="macro">matches!</span>( |
| <a href=#273 id=273 data-nosnippet>273</a> c, |
| <a href=#274 id=274 data-nosnippet>274</a> <span class="comment">// End-of-line characters |
| <a href=#275 id=275 data-nosnippet>275</a> </span>| <span class="string">'\u{000A}' </span><span class="comment">// line feed (\n) |
| <a href=#276 id=276 data-nosnippet>276</a> </span>| <span class="string">'\u{000B}' </span><span class="comment">// vertical tab |
| <a href=#277 id=277 data-nosnippet>277</a> </span>| <span class="string">'\u{000C}' </span><span class="comment">// form feed |
| <a href=#278 id=278 data-nosnippet>278</a> </span>| <span class="string">'\u{000D}' </span><span class="comment">// carriage return (\r) |
| <a href=#279 id=279 data-nosnippet>279</a> </span>| <span class="string">'\u{0085}' </span><span class="comment">// next line (from latin1) |
| <a href=#280 id=280 data-nosnippet>280</a> </span>| <span class="string">'\u{2028}' </span><span class="comment">// LINE SEPARATOR |
| <a href=#281 id=281 data-nosnippet>281</a> </span>| <span class="string">'\u{2029}' </span><span class="comment">// PARAGRAPH SEPARATOR |
| <a href=#282 id=282 data-nosnippet>282</a> |
| <a href=#283 id=283 data-nosnippet>283</a> // `Default_Ignorable_Code_Point` characters |
| <a href=#284 id=284 data-nosnippet>284</a> </span>| <span class="string">'\u{200E}' </span><span class="comment">// LEFT-TO-RIGHT MARK |
| <a href=#285 id=285 data-nosnippet>285</a> </span>| <span class="string">'\u{200F}' </span><span class="comment">// RIGHT-TO-LEFT MARK |
| <a href=#286 id=286 data-nosnippet>286</a> |
| <a href=#287 id=287 data-nosnippet>287</a> // Horizontal space characters |
| <a href=#288 id=288 data-nosnippet>288</a> </span>| <span class="string">'\u{0009}' </span><span class="comment">// tab (\t) |
| <a href=#289 id=289 data-nosnippet>289</a> </span>| <span class="string">'\u{0020}' </span><span class="comment">// space |
| <a href=#290 id=290 data-nosnippet>290</a> </span>) |
| <a href=#291 id=291 data-nosnippet>291</a>} |
| <a href=#292 id=292 data-nosnippet>292</a> |
| <a href=#293 id=293 data-nosnippet>293</a><span class="doccomment">/// True if `c` is considered horizontal whitespace according to Rust language definition. |
| <a href=#294 id=294 data-nosnippet>294</a></span><span class="kw">fn </span>is_horizontal_whitespace(c: char) -> bool { |
| <a href=#295 id=295 data-nosnippet>295</a> <span class="comment">// This is Pattern_White_Space. |
| <a href=#296 id=296 data-nosnippet>296</a> // |
| <a href=#297 id=297 data-nosnippet>297</a> // Note that this set is stable (ie, it doesn't change with different |
| <a href=#298 id=298 data-nosnippet>298</a> // Unicode versions), so it's ok to just hard-code the values. |
| <a href=#299 id=299 data-nosnippet>299</a> |
| <a href=#300 id=300 data-nosnippet>300</a> </span><span class="macro">matches!</span>( |
| <a href=#301 id=301 data-nosnippet>301</a> c, |
| <a href=#302 id=302 data-nosnippet>302</a> <span class="comment">// Horizontal space characters |
| <a href=#303 id=303 data-nosnippet>303</a> </span><span class="string">'\u{0009}' </span><span class="comment">// tab (\t) |
| <a href=#304 id=304 data-nosnippet>304</a> </span>| <span class="string">'\u{0020}' </span><span class="comment">// space |
| <a href=#305 id=305 data-nosnippet>305</a> </span>) |
| <a href=#306 id=306 data-nosnippet>306</a>} |
| <a href=#307 id=307 data-nosnippet>307</a> |
| <a href=#308 id=308 data-nosnippet>308</a><span class="kw">fn </span>strip_newline(text: <span class="kw-2">&</span>str) -> <span class="kw-2">&</span>str { |
| <a href=#309 id=309 data-nosnippet>309</a> text.strip_suffix(<span class="string">"\r\n"</span>).or_else(|| text.strip_suffix(<span class="string">'\n'</span>)).unwrap_or(text) |
| <a href=#310 id=310 data-nosnippet>310</a>} |
| <a href=#311 id=311 data-nosnippet>311</a> |
| <a href=#312 id=312 data-nosnippet>312</a><span class="attr">#[derive(Debug)] |
| <a href=#313 id=313 data-nosnippet>313</a></span><span class="kw">pub struct </span>FrontmatterError { |
| <a href=#314 id=314 data-nosnippet>314</a> message: String, |
| <a href=#315 id=315 data-nosnippet>315</a> primary_span: Span, |
| <a href=#316 id=316 data-nosnippet>316</a> visible_spans: Vec<Span>, |
| <a href=#317 id=317 data-nosnippet>317</a>} |
| <a href=#318 id=318 data-nosnippet>318</a> |
| <a href=#319 id=319 data-nosnippet>319</a><span class="kw">impl </span>FrontmatterError { |
| <a href=#320 id=320 data-nosnippet>320</a> <span class="kw">pub fn </span>new(message: <span class="kw">impl </span>Into<String>, span: Span) -> <span class="self">Self </span>{ |
| <a href=#321 id=321 data-nosnippet>321</a> <span class="self">Self </span>{ message: message.into(), primary_span: span, visible_spans: Vec::new() } |
| <a href=#322 id=322 data-nosnippet>322</a> } |
| <a href=#323 id=323 data-nosnippet>323</a> |
| <a href=#324 id=324 data-nosnippet>324</a> <span class="kw">pub fn </span>push_visible_span(<span class="kw-2">mut </span><span class="self">self</span>, span: Span) -> <span class="self">Self </span>{ |
| <a href=#325 id=325 data-nosnippet>325</a> <span class="self">self</span>.visible_spans.push(span); |
| <a href=#326 id=326 data-nosnippet>326</a> <span class="self">self |
| <a href=#327 id=327 data-nosnippet>327</a> </span>} |
| <a href=#328 id=328 data-nosnippet>328</a> |
| <a href=#329 id=329 data-nosnippet>329</a> <span class="kw">pub fn </span>message(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>str { |
| <a href=#330 id=330 data-nosnippet>330</a> <span class="self">self</span>.message.as_str() |
| <a href=#331 id=331 data-nosnippet>331</a> } |
| <a href=#332 id=332 data-nosnippet>332</a> |
| <a href=#333 id=333 data-nosnippet>333</a> <span class="kw">pub fn </span>primary_span(<span class="kw-2">&</span><span class="self">self</span>) -> Span { |
| <a href=#334 id=334 data-nosnippet>334</a> <span class="self">self</span>.primary_span.clone() |
| <a href=#335 id=335 data-nosnippet>335</a> } |
| <a href=#336 id=336 data-nosnippet>336</a> |
| <a href=#337 id=337 data-nosnippet>337</a> <span class="kw">pub fn </span>visible_spans(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>[Span] { |
| <a href=#338 id=338 data-nosnippet>338</a> <span class="kw-2">&</span><span class="self">self</span>.visible_spans |
| <a href=#339 id=339 data-nosnippet>339</a> } |
| <a href=#340 id=340 data-nosnippet>340</a>} |
| <a href=#341 id=341 data-nosnippet>341</a> |
| <a href=#342 id=342 data-nosnippet>342</a><span class="kw">impl </span>std::fmt::Display <span class="kw">for </span>FrontmatterError { |
| <a href=#343 id=343 data-nosnippet>343</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, fmt: <span class="kw-2">&mut </span>std::fmt::Formatter<<span class="lifetime">'_</span>>) -> std::fmt::Result { |
| <a href=#344 id=344 data-nosnippet>344</a> <span class="self">self</span>.message.fmt(fmt) |
| <a href=#345 id=345 data-nosnippet>345</a> } |
| <a href=#346 id=346 data-nosnippet>346</a>} |
| <a href=#347 id=347 data-nosnippet>347</a> |
| <a href=#348 id=348 data-nosnippet>348</a><span class="kw">impl </span>std::error::Error <span class="kw">for </span>FrontmatterError {}</code></pre></div></section></main></body></html> |
