Files
rust-analyzer/syntax/syntax_editor/index.html
github-merge-queue[bot] c6bc4ae24a deploy: fc55443041
2026-02-07 13:27:32 +00:00

4 lines
7.1 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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="Syntax Tree editor"><title>syntax::syntax_editor - Rust</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="syntax" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.0 (254b59607 2026-01-19)" data-channel="1.93.0" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.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 mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module syntax_editor</a></h2></rustdoc-topbar><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 syntax_<wbr>editor</a></h2><h3><a href="#modules">Module Items</a></h3><ul class="block"><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#traits" title="Traits">Traits</a></li><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" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">syntax</a></div><h1>Module <span>syntax_<wbr>editor</span>&nbsp;<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/syntax_editor.rs.html#1-710">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Syntax Tree editor</p>
<p>Inspired by Roslyns <a href="https://github.com/dotnet/roslyn/blob/43b0b05cc4f492fd5de00f6f6717409091df8daa/src/Workspaces/Core/Portable/Editing/SyntaxEditor.cs"><code>SyntaxEditor</code></a>, but is temporarily built upon mutable syntax tree editing.</p>
</div></details><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="edit_algo/index.html" title="mod syntax::syntax_editor::edit_algo">edit_<wbr>algo</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Implementation of applying changes to a syntax tree.</dd><dt><a class="mod" href="edits/index.html" title="mod syntax::syntax_editor::edits">edits</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Structural editing for ast using <code>SyntaxEditor</code></dd><dt><a class="mod" href="mapping/index.html" title="mod syntax::syntax_editor::mapping">mapping</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dd>Maps syntax elements through disjoint syntax nodes.</dd></dl><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.Position.html" title="struct syntax::syntax_editor::Position">Position</a></dt><dd>Position describing where to insert elements</dd><dt><a class="struct" href="struct.SyntaxAnnotation.html" title="struct syntax::syntax_editor::SyntaxAnnotation">Syntax<wbr>Annotation</a></dt><dt><a class="struct" href="struct.SyntaxEdit.html" title="struct syntax::syntax_editor::SyntaxEdit">Syntax<wbr>Edit</a></dt><dd>Represents a completed <a href="struct.SyntaxEditor.html" title="struct syntax::syntax_editor::SyntaxEditor"><code>SyntaxEditor</code></a> operation.</dd><dt><a class="struct" href="struct.SyntaxEditor.html" title="struct syntax::syntax_editor::SyntaxEditor">Syntax<wbr>Editor</a></dt><dt><a class="struct" href="struct.SyntaxMapping.html" title="struct syntax::syntax_editor::SyntaxMapping">Syntax<wbr>Mapping</a></dt><dt><a class="struct" href="struct.SyntaxMappingBuilder.html" title="struct syntax::syntax_editor::SyntaxMappingBuilder">Syntax<wbr>Mapping<wbr>Builder</a></dt></dl><h2 id="enums" class="section-header">Enums<a href="#enums" class="anchor">§</a></h2><dl class="item-table"><dt><a class="enum" href="enum.Change.html" title="enum syntax::syntax_editor::Change">Change</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="enum" href="enum.ChangeKind.html" title="enum syntax::syntax_editor::ChangeKind">Change<wbr>Kind</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="enum" href="enum.PositionRepr.html" title="enum syntax::syntax_editor::PositionRepr">Position<wbr>Repr</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl><h2 id="traits" class="section-header">Traits<a href="#traits" class="anchor">§</a></h2><dl class="item-table"><dt><a class="trait" href="trait.Element.html" title="trait syntax::syntax_editor::Element">Element</a></dt><dd>Utility trait to allow calling syntax editor functions with references or owned
nodes. Do not use outside of this module.</dd><dt><a class="trait" href="trait.Removable.html" title="trait syntax::syntax_editor::Removable">Removable</a></dt></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.is_ancestor_or_self.html" title="fn syntax::syntax_editor::is_ancestor_or_self">is_<wbr>ancestor_<wbr>or_<wbr>self</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt><dt><a class="fn" href="fn.is_ancestor_or_self_of_element.html" title="fn syntax::syntax_editor::is_ancestor_or_self_of_element">is_<wbr>ancestor_<wbr>or_<wbr>self_<wbr>of_<wbr>element</a><span title="Restricted Visibility">&nbsp;🔒</span> </dt></dl></section></div></main></body></html>