| <!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="`mbe` (short for Macro By Example) crate contains code for handling `macro_rules` macros. It uses `TokenTree` (from `tt` package) as the interface, although it contains some code to bridge `SyntaxNode`s and `TokenTree`s as well!"><title>mbe - 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" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-84e720fa.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="mbe" data-themes="" data-resource-suffix="" data-rustdoc-version="1.89.0 (29483883e 2025-08-04)" data-channel="1.89.0" data-search-js="search-92309212.js" data-settings-js="settings-5514c975.js" ><script src="../static.files/storage-4e99c027.js"></script><script defer src="../crates.js"></script><script defer src="../static.files/main-fd3af306.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-32bb7600.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 crate"><!--[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="../mbe/index.html">mbe</a><span class="version">0.0.0</span></h2></div><div class="sidebar-elems"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#structs">Crate Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li><li><a href="#enums" title="Enums">Enums</a></li><li><a href="#functions" title="Functions">Functions</a></li><li><a href="#types" title="Type Aliases">Type Aliases</a></li></ul></section><div id="rustdoc-modnav"></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><h1>Crate <span>mbe</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/mbe/lib.rs.html#1-414">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>mbe</code> (short for Macro By Example) crate contains code for handling |
| <code>macro_rules</code> macros. It uses <code>TokenTree</code> (from <code>tt</code> package) as the |
| interface, although it contains some code to bridge <code>SyntaxNode</code>s and |
| <code>TokenTree</code>s as well!</p> |
| <p>The tests for this functionality live in another crate: |
| <code>hir_def::macro_expansion_tests::mbe</code>.</p> |
| </div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.DeclarativeMacro.html" title="struct mbe::DeclarativeMacro">Declarative<wbr>Macro</a></dt><dd>This struct contains AST for a single <code>macro_rules</code> definition. What might |
| be very confusing is that AST has almost exactly the same shape as |
| <code>tt::TokenTree</code>, but there’s a crucial difference: in macro rules, <code>$ident</code> |
| and <code>$()*</code> have special meaning (see <code>Var</code> and <code>Repeat</code> data structures)</dd><dt><a class="struct" href="struct.Delimiter.html" title="struct mbe::Delimiter">Delimiter</a></dt><dt><a class="struct" href="struct.ExpandError.html" title="struct mbe::ExpandError">Expand<wbr>Error</a></dt><dt><a class="struct" href="struct.Punct.html" title="struct mbe::Punct">Punct</a></dt><dt><a class="struct" href="struct.ValueResult.html" title="struct mbe::ValueResult">Value<wbr>Result</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.CountError.html" title="enum mbe::CountError">Count<wbr>Error</a></dt><dt><a class="enum" href="enum.DelimiterKind.html" title="enum mbe::DelimiterKind">Delimiter<wbr>Kind</a></dt><dt><a class="enum" href="enum.ExpandErrorKind.html" title="enum mbe::ExpandErrorKind">Expand<wbr>Error<wbr>Kind</a></dt><dt><a class="enum" href="enum.ParseError.html" title="enum mbe::ParseError">Parse<wbr>Error</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.expect_fragment.html" title="fn mbe::expect_fragment">expect_<wbr>fragment</a></dt></dl><h2 id="types" class="section-header">Type Aliases<a href="#types" class="anchor">§</a></h2><dl class="item-table"><dt><a class="type" href="type.ExpandResult.html" title="type mbe::ExpandResult">Expand<wbr>Result</a></dt><dt><a class="type" href="type.MatchedArmIndex.html" title="type mbe::MatchedArmIndex">Matched<wbr>ArmIndex</a></dt><dd>Index of the matched macro arm on successful expansion.</dd></dl></section></div></main></body></html> |
