rust-analyzer/syntax/algo/index.html
github-merge-queue[bot] cddc2a952f deploy: 9923b0085c
2025-01-11 06:35:13 +00:00

6 lines
No EOL
5.4 KiB
HTML

<!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="Collection of assorted algorithms for syntax trees."><title>syntax::algo - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.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" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="syntax" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../syntax/index.html">syntax</a><span class="version">0.0.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module algo</a></h2><h3><a href="#functions">Module Items</a></h3><ul class="block"><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate syntax</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">syntax</a></span><h1>Module <span>algo</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/syntax/algo.rs.html#1-98">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Collection of assorted algorithms for syntax trees.</p>
</div></details><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.ancestors_at_offset.html" title="fn syntax::algo::ancestors_at_offset">ancestors_<wbr>at_<wbr>offset</a></div><div class="desc docblock-short">Returns ancestors of the node at the offset, sorted by length. This should
do the right thing at an edge, e.g. when searching for expressions at <code>{ $0foo }</code> we will get the name reference instead of the whole block, which
we would get if we just did <code>find_token_at_offset(...).flat_map(|t| t.parent().ancestors())</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.find_node_at_offset.html" title="fn syntax::algo::find_node_at_offset">find_<wbr>node_<wbr>at_<wbr>offset</a></div><div class="desc docblock-short">Finds a node of specific Ast type at offset. Note that this is slightly
imprecise: if the cursor is strictly between two nodes of the desired type,
as in</div></li><li><div class="item-name"><a class="fn" href="fn.find_node_at_range.html" title="fn syntax::algo::find_node_at_range">find_<wbr>node_<wbr>at_<wbr>range</a></div></li><li><div class="item-name"><a class="fn" href="fn.has_errors.html" title="fn syntax::algo::has_errors">has_<wbr>errors</a></div></li><li><div class="item-name"><a class="fn" href="fn.least_common_ancestor.html" title="fn syntax::algo::least_common_ancestor">least_<wbr>common_<wbr>ancestor</a></div></li><li><div class="item-name"><a class="fn" href="fn.neighbor.html" title="fn syntax::algo::neighbor">neighbor</a></div></li><li><div class="item-name"><a class="fn" href="fn.non_trivia_sibling.html" title="fn syntax::algo::non_trivia_sibling">non_<wbr>trivia_<wbr>sibling</a></div><div class="desc docblock-short">Finds the first sibling in the given direction which is not <code>trivia</code></div></li><li><div class="item-name"><a class="fn" href="fn.skip_trivia_token.html" title="fn syntax::algo::skip_trivia_token">skip_<wbr>trivia_<wbr>token</a></div><div class="desc docblock-short">Skip to next non <code>trivia</code> token</div></li><li><div class="item-name"><a class="fn" href="fn.skip_whitespace_token.html" title="fn syntax::algo::skip_whitespace_token">skip_<wbr>whitespace_<wbr>token</a></div><div class="desc docblock-short">Skip to next non <code>whitespace</code> token</div></li></ul></section></div></main></body></html>