| <!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 `xtask/src/codegen/feature_docs.rs`."><title>feature_docs.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-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="xtask" data-themes="" data-resource-suffix="" data-rustdoc-version="1.92.0 (ded5c06cf 2025-12-08)" data-channel="1.92.0" data-search-js="search-d69d8955.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-ce535bd0.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">xtask/codegen/</div>feature_docs.rs</h1><rustdoc-toolbar></rustdoc-toolbar></div><div class="example-wrap digits-2"><pre class="rust"><code><a href=#1 id=1 data-nosnippet>1</a><span class="doccomment">//! Generates `features_generated.md` documentation. |
| <a href=#2 id=2 data-nosnippet>2</a> |
| <a href=#3 id=3 data-nosnippet>3</a></span><span class="kw">use </span>std::{fmt, fs, io, path::PathBuf}; |
| <a href=#4 id=4 data-nosnippet>4</a> |
| <a href=#5 id=5 data-nosnippet>5</a><span class="kw">use crate</span>::{ |
| <a href=#6 id=6 data-nosnippet>6</a> codegen::{CommentBlock, Location, add_preamble}, |
| <a href=#7 id=7 data-nosnippet>7</a> project_root, |
| <a href=#8 id=8 data-nosnippet>8</a> util::list_rust_files, |
| <a href=#9 id=9 data-nosnippet>9</a>}; |
| <a href=#10 id=10 data-nosnippet>10</a> |
| <a href=#11 id=11 data-nosnippet>11</a><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>generate(check: bool) { |
| <a href=#12 id=12 data-nosnippet>12</a> <span class="kw">let </span>features = Feature::collect().unwrap(); |
| <a href=#13 id=13 data-nosnippet>13</a> <span class="comment">// Do not generate docs when run with `--check` |
| <a href=#14 id=14 data-nosnippet>14</a> </span><span class="kw">if </span>check { |
| <a href=#15 id=15 data-nosnippet>15</a> <span class="kw">return</span>; |
| <a href=#16 id=16 data-nosnippet>16</a> } |
| <a href=#17 id=17 data-nosnippet>17</a> <span class="kw">let </span>contents = features.into_iter().map(|it| it.to_string()).collect::<Vec<<span class="kw">_</span>>>().join(<span class="string">"\n\n"</span>); |
| <a href=#18 id=18 data-nosnippet>18</a> <span class="kw">let </span>contents = add_preamble(<span class="kw">crate</span>::flags::CodegenType::FeatureDocs, contents); |
| <a href=#19 id=19 data-nosnippet>19</a> <span class="kw">let </span>dst = project_root().join(<span class="string">"docs/book/src/features_generated.md"</span>); |
| <a href=#20 id=20 data-nosnippet>20</a> fs::write(dst, contents).unwrap(); |
| <a href=#21 id=21 data-nosnippet>21</a>} |
| <a href=#22 id=22 data-nosnippet>22</a> |
| <a href=#23 id=23 data-nosnippet>23</a><span class="attr">#[derive(Debug)] |
| <a href=#24 id=24 data-nosnippet>24</a></span><span class="kw">struct </span>Feature { |
| <a href=#25 id=25 data-nosnippet>25</a> id: String, |
| <a href=#26 id=26 data-nosnippet>26</a> location: Location, |
| <a href=#27 id=27 data-nosnippet>27</a> doc: String, |
| <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>Feature { |
| <a href=#31 id=31 data-nosnippet>31</a> <span class="kw">fn </span>collect() -> io::Result<Vec<Feature>> { |
| <a href=#32 id=32 data-nosnippet>32</a> <span class="kw">let </span>crates_dir = project_root().join(<span class="string">"crates"</span>); |
| <a href=#33 id=33 data-nosnippet>33</a> |
| <a href=#34 id=34 data-nosnippet>34</a> <span class="kw">let </span><span class="kw-2">mut </span>res = Vec::new(); |
| <a href=#35 id=35 data-nosnippet>35</a> <span class="kw">for </span>path <span class="kw">in </span>list_rust_files(<span class="kw-2">&</span>crates_dir) { |
| <a href=#36 id=36 data-nosnippet>36</a> collect_file(<span class="kw-2">&mut </span>res, path)<span class="question-mark">?</span>; |
| <a href=#37 id=37 data-nosnippet>37</a> } |
| <a href=#38 id=38 data-nosnippet>38</a> res.sort_by(|lhs, rhs| lhs.id.cmp(<span class="kw-2">&</span>rhs.id)); |
| <a href=#39 id=39 data-nosnippet>39</a> <span class="kw">return </span><span class="prelude-val">Ok</span>(res); |
| <a href=#40 id=40 data-nosnippet>40</a> |
| <a href=#41 id=41 data-nosnippet>41</a> <span class="kw">fn </span>collect_file(acc: <span class="kw-2">&mut </span>Vec<Feature>, path: PathBuf) -> io::Result<()> { |
| <a href=#42 id=42 data-nosnippet>42</a> <span class="kw">let </span>text = std::fs::read_to_string(<span class="kw-2">&</span>path)<span class="question-mark">?</span>; |
| <a href=#43 id=43 data-nosnippet>43</a> <span class="kw">let </span>comment_blocks = CommentBlock::extract(<span class="string">"Feature"</span>, <span class="kw-2">&</span>text); |
| <a href=#44 id=44 data-nosnippet>44</a> |
| <a href=#45 id=45 data-nosnippet>45</a> <span class="kw">for </span>block <span class="kw">in </span>comment_blocks { |
| <a href=#46 id=46 data-nosnippet>46</a> <span class="kw">let </span>id = block.id; |
| <a href=#47 id=47 data-nosnippet>47</a> <span class="kw">if let </span><span class="prelude-val">Err</span>(msg) = is_valid_feature_name(<span class="kw-2">&</span>id) { |
| <a href=#48 id=48 data-nosnippet>48</a> <span class="macro">panic!</span>(<span class="string">"invalid feature name: {id:?}:\n {msg}"</span>) |
| <a href=#49 id=49 data-nosnippet>49</a> } |
| <a href=#50 id=50 data-nosnippet>50</a> <span class="kw">let </span>doc = block.contents.join(<span class="string">"\n"</span>); |
| <a href=#51 id=51 data-nosnippet>51</a> <span class="kw">let </span>location = Location { file: path.clone(), line: block.line }; |
| <a href=#52 id=52 data-nosnippet>52</a> acc.push(Feature { id, location, doc }) |
| <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="prelude-val">Ok</span>(()) |
| <a href=#56 id=56 data-nosnippet>56</a> } |
| <a href=#57 id=57 data-nosnippet>57</a> } |
| <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="kw">fn </span>is_valid_feature_name(feature: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Result</span><(), String> { |
| <a href=#61 id=61 data-nosnippet>61</a> <span class="lifetime">'word</span>: <span class="kw">for </span>word <span class="kw">in </span>feature.split_whitespace() { |
| <a href=#62 id=62 data-nosnippet>62</a> <span class="kw">for </span>short <span class="kw">in </span>[<span class="string">"to"</span>, <span class="string">"and"</span>] { |
| <a href=#63 id=63 data-nosnippet>63</a> <span class="kw">if </span>word == short { |
| <a href=#64 id=64 data-nosnippet>64</a> <span class="kw">continue </span><span class="lifetime">'word</span>; |
| <a href=#65 id=65 data-nosnippet>65</a> } |
| <a href=#66 id=66 data-nosnippet>66</a> } |
| <a href=#67 id=67 data-nosnippet>67</a> <span class="kw">for </span>short <span class="kw">in </span>[<span class="string">"To"</span>, <span class="string">"And"</span>] { |
| <a href=#68 id=68 data-nosnippet>68</a> <span class="kw">if </span>word == short { |
| <a href=#69 id=69 data-nosnippet>69</a> <span class="kw">return </span><span class="prelude-val">Err</span>(<span class="macro">format!</span>(<span class="string">"Don't capitalize {word:?}"</span>)); |
| <a href=#70 id=70 data-nosnippet>70</a> } |
| <a href=#71 id=71 data-nosnippet>71</a> } |
| <a href=#72 id=72 data-nosnippet>72</a> <span class="kw">if </span>!word.starts_with(char::is_uppercase) { |
| <a href=#73 id=73 data-nosnippet>73</a> <span class="kw">return </span><span class="prelude-val">Err</span>(<span class="macro">format!</span>(<span class="string">"Capitalize {word:?}"</span>)); |
| <a href=#74 id=74 data-nosnippet>74</a> } |
| <a href=#75 id=75 data-nosnippet>75</a> } |
| <a href=#76 id=76 data-nosnippet>76</a> <span class="prelude-val">Ok</span>(()) |
| <a href=#77 id=77 data-nosnippet>77</a>} |
| <a href=#78 id=78 data-nosnippet>78</a> |
| <a href=#79 id=79 data-nosnippet>79</a><span class="kw">impl </span>fmt::Display <span class="kw">for </span>Feature { |
| <a href=#80 id=80 data-nosnippet>80</a> <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { |
| <a href=#81 id=81 data-nosnippet>81</a> <span class="macro">writeln!</span>(f, <span class="string">"### {}\n**Source:** {}\n{}"</span>, <span class="self">self</span>.id, <span class="self">self</span>.location, <span class="self">self</span>.doc) |
| <a href=#82 id=82 data-nosnippet>82</a> } |
| <a href=#83 id=83 data-nosnippet>83</a>}</code></pre></div></section></main></body></html> |
