| <!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-ssr/src/from_comment.rs`."><title>from_comment.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_ssr" 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_ssr/</div>from_comment.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">//! This module allows building an SSR MatchFinder by parsing the SSR rule |
| <a href=#2 id=2 data-nosnippet>2</a>//! from a comment. |
| <a href=#3 id=3 data-nosnippet>3</a> |
| <a href=#4 id=4 data-nosnippet>4</a></span><span class="kw">use </span>ide_db::{EditionedFileId, FilePosition, FileRange, RootDatabase, base_db::RootQueryDb}; |
| <a href=#5 id=5 data-nosnippet>5</a><span class="kw">use </span>syntax::{ |
| <a href=#6 id=6 data-nosnippet>6</a> TextRange, |
| <a href=#7 id=7 data-nosnippet>7</a> ast::{<span class="self">self</span>, AstNode, AstToken}, |
| <a href=#8 id=8 data-nosnippet>8</a>}; |
| <a href=#9 id=9 data-nosnippet>9</a> |
| <a href=#10 id=10 data-nosnippet>10</a><span class="kw">use </span><span class="kw">crate</span>::MatchFinder; |
| <a href=#11 id=11 data-nosnippet>11</a> |
| <a href=#12 id=12 data-nosnippet>12</a><span class="doccomment">/// Attempts to build an SSR MatchFinder from a comment at the given file |
| <a href=#13 id=13 data-nosnippet>13</a>/// range. If successful, returns the MatchFinder and a TextRange covering |
| <a href=#14 id=14 data-nosnippet>14</a>/// comment. |
| <a href=#15 id=15 data-nosnippet>15</a></span><span class="kw">pub fn </span>ssr_from_comment( |
| <a href=#16 id=16 data-nosnippet>16</a> db: <span class="kw-2">&</span>RootDatabase, |
| <a href=#17 id=17 data-nosnippet>17</a> frange: FileRange, |
| <a href=#18 id=18 data-nosnippet>18</a>) -> <span class="prelude-ty">Option</span><(MatchFinder<<span class="lifetime">'_</span>>, TextRange)> { |
| <a href=#19 id=19 data-nosnippet>19</a> <span class="kw">let </span>comment = { |
| <a href=#20 id=20 data-nosnippet>20</a> <span class="kw">let </span>file_id = EditionedFileId::current_edition(db, frange.file_id); |
| <a href=#21 id=21 data-nosnippet>21</a> |
| <a href=#22 id=22 data-nosnippet>22</a> <span class="kw">let </span>file = db.parse(file_id); |
| <a href=#23 id=23 data-nosnippet>23</a> file.tree().syntax().token_at_offset(frange.range.start()).find_map(ast::Comment::cast) |
| <a href=#24 id=24 data-nosnippet>24</a> }<span class="question-mark">?</span>; |
| <a href=#25 id=25 data-nosnippet>25</a> <span class="kw">let </span>comment_text_without_prefix = comment.text().strip_prefix(comment.prefix()).unwrap(); |
| <a href=#26 id=26 data-nosnippet>26</a> <span class="kw">let </span>ssr_rule = comment_text_without_prefix.parse().ok()<span class="question-mark">?</span>; |
| <a href=#27 id=27 data-nosnippet>27</a> |
| <a href=#28 id=28 data-nosnippet>28</a> <span class="kw">let </span>lookup_context = FilePosition { file_id: frange.file_id, offset: frange.range.start() }; |
| <a href=#29 id=29 data-nosnippet>29</a> |
| <a href=#30 id=30 data-nosnippet>30</a> <span class="kw">let </span><span class="kw-2">mut </span>match_finder = MatchFinder::in_context(db, lookup_context, <span class="macro">vec!</span>[]).ok()<span class="question-mark">?</span>; |
| <a href=#31 id=31 data-nosnippet>31</a> match_finder.add_rule(ssr_rule).ok()<span class="question-mark">?</span>; |
| <a href=#32 id=32 data-nosnippet>32</a> |
| <a href=#33 id=33 data-nosnippet>33</a> <span class="prelude-val">Some</span>((match_finder, comment.syntax().text_range())) |
| <a href=#34 id=34 data-nosnippet>34</a>} |
| </code></pre></div></section></main></body></html> |
