sascha
/
difftastic
mirror of https://github.com/Wilfred/difftastic/
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
difftastic/rustdoc/tree_sitter_ocaml/index.html

24 lines
8.5 KiB
HTML
Raw Permalink Blame History Unescape Escape

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 OCaml language support for the tree-sitter parsing library. There are separate languages for implementation, (`.ml`), interfaces (`.mli`) and types."><title>tree_sitter_ocaml - 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_ocaml" 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_ocaml/index.html">tree_sitter_ocaml</a><span class="version">0.23.2</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_ocaml/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_ocaml</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_ocaml/lib.rs.html#1-131">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 OCaml language support for the <a href="https://tree-sitter.github.io/">tree-sitter</a> parsing
library. There are separate languages for implementation, (<code>.ml</code>),
interfaces (<code>.mli</code>) and types.</p>
<p>Typically, you will use <a href="constant.LANGUAGE_OCAML.html"><code>LANGUAGE_OCAML</code></a> to add this language
to a tree-sitter <a href="https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html"><code>Parser</code></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">let </span>code = <span class="string">r#"
module M = struct
let x = 0
end
"#</span>;
<span class="kw">let </span><span class="kw-2">mut </span>parser = tree_sitter::Parser::new();
<span class="kw">let </span>language = tree_sitter_ocaml::LANGUAGE_OCAML;
parser
.set_language(<span class="kw-2">&amp;</span>language.into())
.expect(<span class="string">"Error loading OCaml language"</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>
<p>Use <a href="constant.LANGUAGE_OCAML_INTERFACE.html"><code>LANGUAGE_OCAML_INTERFACE</code></a> to parse interface
files (with <code>.mli</code> extension) and <a href="constant.LANGUAGE_OCAML_TYPE.html"><code>LANGUAGE_OCAML_TYPE</code></a>
to parse type signatures.</p>
</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_ocaml::HIGHLIGHTS_QUERY">HIGHLIGHTS_QUERY</a></div><div class="desc docblock-short">The syntax highlighting query for OCaml.</div></li><li><div class="item-name"><a class="constant" href="constant.INTERFACE_NODE_TYPES.html" title="constant tree_sitter_ocaml::INTERFACE_NODE_TYPES">INTERFACE_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 OCaml interfaces.</div></li><li><div class="item-name"><a class="constant" href="constant.LANGUAGE_OCAML.html" title="constant tree_sitter_ocaml::LANGUAGE_OCAML">LANGUAGE_OCAML</a></div><div class="desc docblock-short">The tree-sitter <a href="https://docs.rs/tree-sitter-language/*/tree_sitter_language/struct.LanguageFn.html"><code>LanguageFn</code></a> for OCaml.</div></li><li><div class="item-name"><a class="constant" href="constant.LANGUAGE_OCAML_INTERFACE.html" title="constant tree_sitter_ocaml::LANGUAGE_OCAML_INTERFACE">LANGUAGE_OCAML_INTERFACE</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 OCaml interfaces.</div></li><li><div class="item-name"><a class="constant" href="constant.LANGUAGE_OCAML_TYPE.html" title="constant tree_sitter_ocaml::LANGUAGE_OCAML_TYPE">LANGUAGE_OCAML_TYPE</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 OCaml types.</div></li><li><div class="item-name"><a class="constant" href="constant.LOCALS_QUERY.html" title="constant tree_sitter_ocaml::LOCALS_QUERY">LOCALS_QUERY</a></div><div class="desc docblock-short">The local-variable syntax highlighting query for OCaml.</div></li><li><div class="item-name"><a class="constant" href="constant.OCAML_NODE_TYPES.html" title="constant tree_sitter_ocaml::OCAML_NODE_TYPES">OCAML_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 OCaml.</div></li><li><div class="item-name"><a class="constant" href="constant.TAGS_QUERY.html" title="constant tree_sitter_ocaml::TAGS_QUERY">TAGS_QUERY</a></div><div class="desc docblock-short">The symbol tagging query for OCaml.</div></li><li><div class="item-name"><a class="constant" href="constant.TYPE_NODE_TYPES.html" title="constant tree_sitter_ocaml::TYPE_NODE_TYPES">TYPE_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 OCaml types.</div></li></ul></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink