| <!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/ide/src/markdown_remove.rs`."><title>markdown_remove.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="ide" 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">ide/</div>markdown_remove.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">//! Removes markdown from strings. |
| <a href=#2 id=2 data-nosnippet>2</a></span><span class="kw">use </span>pulldown_cmark::{Event, Parser, Tag}; |
| <a href=#3 id=3 data-nosnippet>3</a> |
| <a href=#4 id=4 data-nosnippet>4</a><span class="doccomment">/// Removes all markdown, keeping the text and code blocks |
| <a href=#5 id=5 data-nosnippet>5</a>/// |
| <a href=#6 id=6 data-nosnippet>6</a>/// Currently limited in styling, i.e. no ascii tables or lists |
| <a href=#7 id=7 data-nosnippet>7</a></span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>remove_markdown(markdown: <span class="kw-2">&</span>str) -> String { |
| <a href=#8 id=8 data-nosnippet>8</a> <span class="kw">let </span><span class="kw-2">mut </span>out = String::new(); |
| <a href=#9 id=9 data-nosnippet>9</a> out.reserve_exact(markdown.len()); |
| <a href=#10 id=10 data-nosnippet>10</a> <span class="kw">let </span>parser = Parser::new(markdown); |
| <a href=#11 id=11 data-nosnippet>11</a> |
| <a href=#12 id=12 data-nosnippet>12</a> <span class="kw">for </span>event <span class="kw">in </span>parser { |
| <a href=#13 id=13 data-nosnippet>13</a> <span class="kw">match </span>event { |
| <a href=#14 id=14 data-nosnippet>14</a> Event::Text(text) | Event::Code(text) => out.push_str(<span class="kw-2">&</span>text), |
| <a href=#15 id=15 data-nosnippet>15</a> Event::SoftBreak => out.push(<span class="string">' '</span>), |
| <a href=#16 id=16 data-nosnippet>16</a> Event::HardBreak | Event::Rule | Event::End(Tag::CodeBlock(<span class="kw">_</span>)) => out.push(<span class="string">'\n'</span>), |
| <a href=#17 id=17 data-nosnippet>17</a> Event::End(Tag::Paragraph) => out.push_str(<span class="string">"\n\n"</span>), |
| <a href=#18 id=18 data-nosnippet>18</a> Event::Start(<span class="kw">_</span>) |
| <a href=#19 id=19 data-nosnippet>19</a> | Event::End(<span class="kw">_</span>) |
| <a href=#20 id=20 data-nosnippet>20</a> | Event::Html(<span class="kw">_</span>) |
| <a href=#21 id=21 data-nosnippet>21</a> | Event::FootnoteReference(<span class="kw">_</span>) |
| <a href=#22 id=22 data-nosnippet>22</a> | Event::TaskListMarker(<span class="kw">_</span>) => (), |
| <a href=#23 id=23 data-nosnippet>23</a> } |
| <a href=#24 id=24 data-nosnippet>24</a> } |
| <a href=#25 id=25 data-nosnippet>25</a> |
| <a href=#26 id=26 data-nosnippet>26</a> <span class="kw">if let </span><span class="prelude-val">Some</span>(<span class="kw-2">mut </span>p) = out.rfind(|c| <span class="macro">c !</span>= <span class="string">'\n'</span>) { |
| <a href=#27 id=27 data-nosnippet>27</a> <span class="kw">while </span>!out.is_char_boundary(p + <span class="number">1</span>) { |
| <a href=#28 id=28 data-nosnippet>28</a> p += <span class="number">1</span>; |
| <a href=#29 id=29 data-nosnippet>29</a> } |
| <a href=#30 id=30 data-nosnippet>30</a> out.drain(p + <span class="number">1</span>..); |
| <a href=#31 id=31 data-nosnippet>31</a> } |
| <a href=#32 id=32 data-nosnippet>32</a> |
| <a href=#33 id=33 data-nosnippet>33</a> out |
| <a href=#34 id=34 data-nosnippet>34</a>} |
| <a href=#35 id=35 data-nosnippet>35</a> |
| <a href=#36 id=36 data-nosnippet>36</a><span class="attr">#[cfg(test)] |
| <a href=#37 id=37 data-nosnippet>37</a></span><span class="kw">mod </span>tests { |
| <a href=#38 id=38 data-nosnippet>38</a> <span class="kw">use </span>expect_test::expect; |
| <a href=#39 id=39 data-nosnippet>39</a> |
| <a href=#40 id=40 data-nosnippet>40</a> <span class="kw">use </span>super::<span class="kw-2">*</span>; |
| <a href=#41 id=41 data-nosnippet>41</a> |
| <a href=#42 id=42 data-nosnippet>42</a> <span class="attr">#[test] |
| <a href=#43 id=43 data-nosnippet>43</a> </span><span class="kw">fn </span>smoke_test() { |
| <a href=#44 id=44 data-nosnippet>44</a> <span class="kw">let </span>res = remove_markdown( |
| <a href=#45 id=45 data-nosnippet>45</a> <span class="string">r##" |
| <a href=#46 id=46 data-nosnippet>46</a>A function or function pointer. |
| <a href=#47 id=47 data-nosnippet>47</a> |
| <a href=#48 id=48 data-nosnippet>48</a>Functions are the primary way code is executed within Rust. Function blocks, usually just |
| <a href=#49 id=49 data-nosnippet>49</a>called functions, can be defined in a variety of different places and be assigned many |
| <a href=#50 id=50 data-nosnippet>50</a>different attributes and modifiers. |
| <a href=#51 id=51 data-nosnippet>51</a> |
| <a href=#52 id=52 data-nosnippet>52</a>Standalone functions that just sit within a module not attached to anything else are common, |
| <a href=#53 id=53 data-nosnippet>53</a>but most functions will end up being inside [`impl`] blocks, either on another type itself, or |
| <a href=#54 id=54 data-nosnippet>54</a>as a trait impl for that type. |
| <a href=#55 id=55 data-nosnippet>55</a> |
| <a href=#56 id=56 data-nosnippet>56</a>```rust |
| <a href=#57 id=57 data-nosnippet>57</a>fn standalone_function() { |
| <a href=#58 id=58 data-nosnippet>58</a> // code |
| <a href=#59 id=59 data-nosnippet>59</a>} |
| <a href=#60 id=60 data-nosnippet>60</a> |
| <a href=#61 id=61 data-nosnippet>61</a>pub fn public_thing(argument: bool) -> String { |
| <a href=#62 id=62 data-nosnippet>62</a> // code |
| <a href=#63 id=63 data-nosnippet>63</a> # "".to_string() |
| <a href=#64 id=64 data-nosnippet>64</a>} |
| <a href=#65 id=65 data-nosnippet>65</a> |
| <a href=#66 id=66 data-nosnippet>66</a>struct Thing { |
| <a href=#67 id=67 data-nosnippet>67</a> foo: i32, |
| <a href=#68 id=68 data-nosnippet>68</a>} |
| <a href=#69 id=69 data-nosnippet>69</a> |
| <a href=#70 id=70 data-nosnippet>70</a>impl Thing { |
| <a href=#71 id=71 data-nosnippet>71</a> pub fn new() -> Self { |
| <a href=#72 id=72 data-nosnippet>72</a> Self { |
| <a href=#73 id=73 data-nosnippet>73</a> foo: 42, |
| <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>} |
| <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>In addition to presenting fixed types in the form of `fn name(arg: type, ..) -> return_type`, |
| <a href=#80 id=80 data-nosnippet>80</a>functions can also declare a list of type parameters along with trait bounds that they fall |
| <a href=#81 id=81 data-nosnippet>81</a>into. |
| <a href=#82 id=82 data-nosnippet>82</a> |
| <a href=#83 id=83 data-nosnippet>83</a>```rust |
| <a href=#84 id=84 data-nosnippet>84</a>fn generic_function<T: Clone>(x: T) -> (T, T, T) { |
| <a href=#85 id=85 data-nosnippet>85</a> (x.clone(), x.clone(), x.clone()) |
| <a href=#86 id=86 data-nosnippet>86</a>} |
| <a href=#87 id=87 data-nosnippet>87</a> |
| <a href=#88 id=88 data-nosnippet>88</a>fn generic_where<T>(x: T) -> T |
| <a href=#89 id=89 data-nosnippet>89</a> where T: std::ops::Add<Output = T> + Copy |
| <a href=#90 id=90 data-nosnippet>90</a>{ |
| <a href=#91 id=91 data-nosnippet>91</a> x + x + x |
| <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> |
| <a href=#95 id=95 data-nosnippet>95</a>Declaring trait bounds in the angle brackets is functionally identical to using a `where` |
| <a href=#96 id=96 data-nosnippet>96</a>clause. It's up to the programmer to decide which works better in each situation, but `where` |
| <a href=#97 id=97 data-nosnippet>97</a>tends to be better when things get longer than one line. |
| <a href=#98 id=98 data-nosnippet>98</a> |
| <a href=#99 id=99 data-nosnippet>99</a>Along with being made public via `pub`, `fn` can also have an [`extern`] added for use in |
| <a href=#100 id=100 data-nosnippet>100</a>FFI. |
| <a href=#101 id=101 data-nosnippet>101</a> |
| <a href=#102 id=102 data-nosnippet>102</a>For more information on the various types of functions and how they're used, consult the [Rust |
| <a href=#103 id=103 data-nosnippet>103</a>book] or the [Reference]. |
| <a href=#104 id=104 data-nosnippet>104</a> |
| <a href=#105 id=105 data-nosnippet>105</a>[`impl`]: keyword.impl.html |
| <a href=#106 id=106 data-nosnippet>106</a>[`extern`]: keyword.extern.html |
| <a href=#107 id=107 data-nosnippet>107</a>[Rust book]: ../book/ch03-03-how-functions-work.html |
| <a href=#108 id=108 data-nosnippet>108</a>[Reference]: ../reference/items/functions.html |
| <a href=#109 id=109 data-nosnippet>109</a>"##</span>, |
| <a href=#110 id=110 data-nosnippet>110</a> ); |
| <a href=#111 id=111 data-nosnippet>111</a> <span class="macro">expect!</span>[[<span class="string">r#" |
| <a href=#112 id=112 data-nosnippet>112</a> A function or function pointer. |
| <a href=#113 id=113 data-nosnippet>113</a> |
| <a href=#114 id=114 data-nosnippet>114</a> Functions are the primary way code is executed within Rust. Function blocks, usually just called functions, can be defined in a variety of different places and be assigned many different attributes and modifiers. |
| <a href=#115 id=115 data-nosnippet>115</a> |
| <a href=#116 id=116 data-nosnippet>116</a> Standalone functions that just sit within a module not attached to anything else are common, but most functions will end up being inside impl blocks, either on another type itself, or as a trait impl for that type. |
| <a href=#117 id=117 data-nosnippet>117</a> |
| <a href=#118 id=118 data-nosnippet>118</a> fn standalone_function() { |
| <a href=#119 id=119 data-nosnippet>119</a> // code |
| <a href=#120 id=120 data-nosnippet>120</a> } |
| <a href=#121 id=121 data-nosnippet>121</a> |
| <a href=#122 id=122 data-nosnippet>122</a> pub fn public_thing(argument: bool) -> String { |
| <a href=#123 id=123 data-nosnippet>123</a> // code |
| <a href=#124 id=124 data-nosnippet>124</a> # "".to_string() |
| <a href=#125 id=125 data-nosnippet>125</a> } |
| <a href=#126 id=126 data-nosnippet>126</a> |
| <a href=#127 id=127 data-nosnippet>127</a> struct Thing { |
| <a href=#128 id=128 data-nosnippet>128</a> foo: i32, |
| <a href=#129 id=129 data-nosnippet>129</a> } |
| <a href=#130 id=130 data-nosnippet>130</a> |
| <a href=#131 id=131 data-nosnippet>131</a> impl Thing { |
| <a href=#132 id=132 data-nosnippet>132</a> pub fn new() -> Self { |
| <a href=#133 id=133 data-nosnippet>133</a> Self { |
| <a href=#134 id=134 data-nosnippet>134</a> foo: 42, |
| <a href=#135 id=135 data-nosnippet>135</a> } |
| <a href=#136 id=136 data-nosnippet>136</a> } |
| <a href=#137 id=137 data-nosnippet>137</a> } |
| <a href=#138 id=138 data-nosnippet>138</a> |
| <a href=#139 id=139 data-nosnippet>139</a> In addition to presenting fixed types in the form of fn name(arg: type, ..) -> return_type, functions can also declare a list of type parameters along with trait bounds that they fall into. |
| <a href=#140 id=140 data-nosnippet>140</a> |
| <a href=#141 id=141 data-nosnippet>141</a> fn generic_function<T: Clone>(x: T) -> (T, T, T) { |
| <a href=#142 id=142 data-nosnippet>142</a> (x.clone(), x.clone(), x.clone()) |
| <a href=#143 id=143 data-nosnippet>143</a> } |
| <a href=#144 id=144 data-nosnippet>144</a> |
| <a href=#145 id=145 data-nosnippet>145</a> fn generic_where<T>(x: T) -> T |
| <a href=#146 id=146 data-nosnippet>146</a> where T: std::ops::Add<Output = T> + Copy |
| <a href=#147 id=147 data-nosnippet>147</a> { |
| <a href=#148 id=148 data-nosnippet>148</a> x + x + x |
| <a href=#149 id=149 data-nosnippet>149</a> } |
| <a href=#150 id=150 data-nosnippet>150</a> |
| <a href=#151 id=151 data-nosnippet>151</a> Declaring trait bounds in the angle brackets is functionally identical to using a where clause. It's up to the programmer to decide which works better in each situation, but where tends to be better when things get longer than one line. |
| <a href=#152 id=152 data-nosnippet>152</a> |
| <a href=#153 id=153 data-nosnippet>153</a> Along with being made public via pub, fn can also have an extern added for use in FFI. |
| <a href=#154 id=154 data-nosnippet>154</a> |
| <a href=#155 id=155 data-nosnippet>155</a> For more information on the various types of functions and how they're used, consult the Rust book or the Reference."#</span>]].assert_eq(<span class="kw-2">&</span>res); |
| <a href=#156 id=156 data-nosnippet>156</a> } |
| <a href=#157 id=157 data-nosnippet>157</a> |
| <a href=#158 id=158 data-nosnippet>158</a> <span class="attr">#[test] |
| <a href=#159 id=159 data-nosnippet>159</a> </span><span class="kw">fn </span>on_char_boundary() { |
| <a href=#160 id=160 data-nosnippet>160</a> <span class="macro">expect!</span>[<span class="string">"a┘"</span>].assert_eq(<span class="kw-2">&</span>remove_markdown(<span class="string">"```text\na┘\n```"</span>)); |
| <a href=#161 id=161 data-nosnippet>161</a> <span class="macro">expect!</span>[<span class="string">"وقار"</span>].assert_eq(<span class="kw-2">&</span>remove_markdown(<span class="string">"```\nوقار\n```\n"</span>)); |
| <a href=#162 id=162 data-nosnippet>162</a> } |
| <a href=#163 id=163 data-nosnippet>163</a>} |
| </code></pre></div></section></main></body></html> |
