|
|
<!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 definitions with change metadata."><title>difft::parse::syntax - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../../" data-static-root-path="../../../static.files/" data-current-crate="difft" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../../static.files/favicon-2c020d218678b618.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">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../../difft/index.html">difft</a><span class="version">0.68.0</span></h2></div><h2 class="location"><a href="#">Module syntax</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#functions">Functions</a></li><li><a href="#types">Type Aliases</a></li></ul></section><h2><a href="../index.html">In difft::parse</a></h2></div></nav><div class="sidebar-resizer"></div>
|
|
|
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../../difft/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Module <a href="../../index.html">difft</a>::<wbr><a href="../index.html">parse</a>::<wbr><a class="mod" href="#">syntax</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../../src/difft/parse/syntax.rs.html#1-1368">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Syntax tree definitions with change metadata.</p>
|
|
|
</div></details><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2><ul class="item-table"><li><div class="item-name"><a class="struct" href="struct.MatchedPos.html" title="struct difft::parse::syntax::MatchedPos">MatchedPos</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="struct" href="struct.SyntaxInfo.html" title="struct difft::parse::syntax::SyntaxInfo">SyntaxInfo</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">Fields that are common to both <code>Syntax::List</code> and <code>Syntax::Atom</code>.</div></li></ul><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2><ul class="item-table"><li><div class="item-name"><a class="enum" href="enum.AtomKind.html" title="enum difft::parse::syntax::AtomKind">AtomKind</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="enum" href="enum.MatchKind.html" title="enum difft::parse::syntax::MatchKind">MatchKind</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">A matched token (an atom, a delimiter, or a comment word).</div></li><li><div class="item-name"><a class="enum" href="enum.StringKind.html" title="enum difft::parse::syntax::StringKind">StringKind</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">Different types of strings. We want to diff these the same way,
|
|
|
but highlight them differently.</div></li><li><div class="item-name"><a class="enum" href="enum.Syntax.html" title="enum difft::parse::syntax::Syntax">Syntax</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="enum" href="enum.TokenKind.html" title="enum difft::parse::syntax::TokenKind">TokenKind</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">Unlike atoms, tokens can be delimiters like <code>{</code>.</div></li></ul><h2 id="functions" class="section-header"><a href="#functions">Functions</a></h2><ul class="item-table"><li><div class="item-name"><a class="fn" href="fn.change_positions.html" title="fn difft::parse::syntax::change_positions">change_positions</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">Walk <code>nodes</code> and return a vec of all the changed positions.</div></li><li><div class="item-name"><a class="fn" href="fn.change_positions_.html" title="fn difft::parse::syntax::change_positions_">change_positions_</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn.comment_positions.html" title="fn difft::parse::syntax::comment_positions">comment_positions</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn.dbg_pos.html" title="fn difft::parse::syntax::dbg_pos">dbg_pos</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn.filter_empty_ends.html" title="fn difft::parse::syntax::filter_empty_ends">filter_empty_ends</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">Skip line spans at the beginning or end that have zero width.</div></li><li><div class="item-name"><a class="fn" href="fn.find_nodes_with_unique_content.html" title="fn difft::parse::syntax::find_nodes_with_unique_content">find_nodes_with_unique_content</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">Assumes that <code>set_content_id</code> has already run.</div></li><li><div class="item-name"><a class="fn" href="fn.has_common_words.html" title="fn difft::parse::syntax::has_common_words">has_common_words</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">Are there sufficient common words that we should only highlight
|
|
|
individual changed words?</div></li><li><div class="item-name"><a class="fn" href="fn.init_all_info.html" title="fn difft::parse::syntax::init_all_info">init_all_info</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">Initialise all the fields in <code>SyntaxInfo</code>.</div></li><li><div class="item-name"><a class="fn" href="fn.init_info.html" title="fn difft::parse::syntax::init_info">init_info</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn.init_info_on_side.html" title="fn difft::parse::syntax::init_info_on_side">init_info_on_side</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">Set all the <code>SyntaxInfo</code> values for all the <code>roots</code> on a single
|
|
|
side (LHS or RHS).</div></li><li><div class="item-name"><a class="fn" href="fn.init_next_prev.html" title="fn difft::parse::syntax::init_next_prev">init_next_prev</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn.print_as_dot.html" title="fn difft::parse::syntax::print_as_dot">print_as_dot</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn.print_as_dot_.html" title="fn difft::parse::syntax::print_as_dot_">print_as_dot_</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn.set_content_id.html" title="fn difft::parse::syntax::set_content_id">set_content_id</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn.set_content_is_unique.html" title="fn difft::parse::syntax::set_content_is_unique">set_content_is_unique</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn.set_content_is_unique_from_counts.html" title="fn difft::parse::syntax::set_content_is_unique_from_counts">set_content_is_unique_from_counts</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn.set_next_sibling.html" title="fn difft::parse::syntax::set_next_sibling">set_next_sibling</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn.set_num_after.html" title="fn difft::parse::syntax::set_num_after">set_num_after</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn.set_num_ancestors.html" title="fn difft::parse::syntax::set_num_ancestors">set_num_ancestors</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn.set_parent.html" title="fn difft::parse::syntax::set_parent">set_parent</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn.set_prev.html" title="fn difft::parse::syntax::set_prev">set_prev</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">For every syntax node in the tree, mark the previous node
|
|
|
according to a preorder traversal.</div></li><li><div class="item-name"><a class="fn" href="fn.set_prev_sibling.html" title="fn difft::parse::syntax::set_prev_sibling">set_prev_sibling</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn.set_unique_id.html" title="fn difft::parse::syntax::set_unique_id">set_unique_id</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn.split_atom_words.html" title="fn difft::parse::syntax::split_atom_words">split_atom_words</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">Given the text <code>content</code> from a comment or string, split it into
|
|
|
<code>MatchedPos</code> values for the novel and unchanged words.</div></li><li><div class="item-name"><a class="fn" href="fn.zip_pad_shorter.html" title="fn difft::parse::syntax::zip_pad_shorter">zip_pad_shorter</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="fn" href="fn.zip_repeat_shorter.html" title="fn difft::parse::syntax::zip_repeat_shorter">zip_repeat_shorter</a><span title="Restricted Visibility"> 🔒</span> </div><div class="desc docblock-short">Zip <code>lhs</code> with <code>rhs</code>, but repeat the last item from the shorter
|
|
|
slice.</div></li></ul><h2 id="types" class="section-header"><a href="#types">Type Aliases</a></h2><ul class="item-table"><li><div class="item-name"><a class="type" href="type.ContentId.html" title="type difft::parse::syntax::ContentId">ContentId</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="type" href="type.ContentKey.html" title="type difft::parse::syntax::ContentKey">ContentKey</a><span title="Restricted Visibility"> 🔒</span> </div></li><li><div class="item-name"><a class="type" href="type.SyntaxId.html" title="type difft::parse::syntax::SyntaxId">SyntaxId</a><span title="Restricted Visibility"> 🔒</span> </div></li></ul></section></div></main></body></html> |