difftastic/rustdoc/tree_sitter_lua/index.html

19 lines
6.7 KiB
HTML

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

<!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="This crate provides Lua language support for the tree-sitter parsing library."><title>tree_sitter_lua - 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="tree_sitter_lua" 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="../crates.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 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">&#9776;</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../tree_sitter_lua/index.html">tree_sitter_lua</a><span class="version">0.2.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><ul class="block"><li><a href="#constants">Constants</a></li></ul></section></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="../tree_sitter_lua/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>Crate <a class="mod" href="#">tree_sitter_lua</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/tree_sitter_lua/lib.rs.html#1-61">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>&#x2212;</span>]</button></span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>This crate provides Lua language support for the <a href="https://tree-sitter.github.io/">tree-sitter</a> parsing library.</p>
<p>Typically, you will use the <a href="fn.language.html">language</a> function to add this language to a
tree-sitter <a href="https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html">Parser</a>, and then use the parser to parse some code:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tree_sitter::Parser;
<span class="kw">let </span>code = <span class="string">r#"
return 42
"#</span>;
<span class="kw">let </span><span class="kw-2">mut </span>parser = Parser::new();
<span class="kw">let </span>language = tree_sitter_lua::LANGUAGE;
parser
.set_language(<span class="kw-2">&amp;</span>language.into())
.expect(<span class="string">"Error loading Lua parser"</span>);
<span class="kw">let </span>tree = parser.parse(code, <span class="prelude-val">None</span>).unwrap();
<span class="macro">assert!</span>(!tree.root_node().has_error());</code></pre></div>
</div></details><h2 id="constants" class="section-header"><a href="#constants">Constants</a></h2><ul class="item-table"><li><div class="item-name"><a class="constant" href="constant.HIGHLIGHTS_QUERY.html" title="constant tree_sitter_lua::HIGHLIGHTS_QUERY">HIGHLIGHTS_QUERY</a></div><div class="desc docblock-short">The syntax highlighting query for this language.</div></li><li><div class="item-name"><a class="constant" href="constant.INJECTIONS_QUERY.html" title="constant tree_sitter_lua::INJECTIONS_QUERY">INJECTIONS_QUERY</a></div><div class="desc docblock-short">The injection query for this language.</div></li><li><div class="item-name"><a class="constant" href="constant.LANGUAGE.html" title="constant tree_sitter_lua::LANGUAGE">LANGUAGE</a></div><div class="desc docblock-short">The tree-sitter <a href="../tree_sitter_language/struct.LanguageFn.html" title="struct tree_sitter_language::LanguageFn"><code>LanguageFn</code></a> for this grammar.</div></li><li><div class="item-name"><a class="constant" href="constant.LOCALS_QUERY.html" title="constant tree_sitter_lua::LOCALS_QUERY">LOCALS_QUERY</a></div><div class="desc docblock-short">The local-variable syntax highlighting query for this language.</div></li><li><div class="item-name"><a class="constant" href="constant.NODE_TYPES.html" title="constant tree_sitter_lua::NODE_TYPES">NODE_TYPES</a></div><div class="desc docblock-short">The content of the <a href="https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types"><code>node-types.json</code></a> file for this grammar.</div></li><li><div class="item-name"><a class="constant" href="constant.TAGS_QUERY.html" title="constant tree_sitter_lua::TAGS_QUERY">TAGS_QUERY</a></div><div class="desc docblock-short">The symbol tagging query for this language.</div></li></ul></section></div></main></body></html>