Mercator/mercator_parser
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: 2020-04-01 17:06:52 +0200: 242de73 - Adding documentation

Browse Source
This commit is contained in:
Lionel Sambuc
2020-04-01 17:57:50 +02:00
parent cd80bc3e23
commit 0f9f34c4e2
3 changed files with 75 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

19
parser/index.html
View File

@@ -1,4 +1,21 @@
<!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="API documentation for the Rust `parser` crate."><meta name="keywords" content="rust, rustlang, rust-lang, parser"><title>parser - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../parser/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate parser</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all parser's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'parser', ty: 'mod', relpath: '../'};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../src/parser/lib.rs.html#1-37' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>parser</a></span></h1><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<!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="API documentation for the Rust `parser` crate."><meta name="keywords" content="rust, rustlang, rust-lang, parser"><title>parser - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../parser/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate parser</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all parser's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#traits">Traits</a></li><li><a href="#types">Type Definitions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'parser', ty: 'mod', relpath: '../'};</script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../src/parser/lib.rs.html#1-65' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>parser</a></span></h1><div class='docblock'><h1 id="mercator-parser" class="section-header"><a href="#mercator-parser">Mercator Parser</a></h1>
<p>Query parser for Mercator.</p>
<h2 id="mercator-spatial-index" class="section-header"><a href="#mercator-spatial-index">Mercator: Spatial Index</a></h2>
<p><strong>Mercator</strong> is a spatial <em>volumetric</em> index for the
<a href="http://www.humanbrainproject.eu">Human Brain Project</a>. It is a component of the <a href="http://www.humanbrainproject.eu/en/explore-the-brain/search/">Knowledge Graph</a>
service, which provides the spatial anchoring for the metadata
registered as well as processes the volumetric queries.</p>
<p>It is build on top of the Iron Sea database toolkit.</p>
<h2 id="iron-sea-database-toolkit" class="section-header"><a href="#iron-sea-database-toolkit">Iron Sea: Database Toolkit</a></h2>
<p><strong>Iron Sea</strong> provides a set of database engine bricks, which can be
combined and applied on arbitrary data structures.</p>
<p>Unlike a traditional database, it does not assume a specific
physical structure for the tables nor the records, but relies on the
developer to provide a set of extractor functions which are used by
the specific indices provided.</p>
<p>This enables the index implementations to be agnostic from the
underlying data structure, and re-used.</p>
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
<table><tr class='module-item'><td><a class="mod" href="queries/index.html" title='parser::queries mod'>queries</a></td><td class='docblock-short'></td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table><tr class='module-item'><td><a class="struct" href="struct.FiltersParser.html" title='parser::FiltersParser struct'>FiltersParser</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="struct" href="struct.QueryParser.html" title='parser::QueryParser struct'>QueryParser</a></td><td class='docblock-short'></td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
<table><tr class='module-item'><td><a class="trait" href="trait.Executor.html" title='parser::Executor trait'>Executor</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="trait" href="trait.Predictor.html" title='parser::Predictor trait'>Predictor</a></td><td class='docblock-short'></td></tr><tr class='module-item'><td><a class="trait" href="trait.Validator.html" title='parser::Validator trait'>Validator</a></td><td class='docblock-short'></td></tr></table><h2 id='types' class='section-header'><a href="#types">Type Definitions</a></h2>

2
search-index.js
View File

File diff suppressed because one or more lines are too long

56
src/parser/lib.rs.html
View File

@@ -35,9 +35,65 @@
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
</pre><div class="example-wrap"><pre class="rust ">
<span class="attribute">#![<span class="ident">forbid</span>(<span class="ident">unsafe_code</span>)]</span>
<span class="doccomment">//! # Mercator Parser</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Query parser for Mercator.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ## Mercator: Spatial Index</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! **Mercator** is a spatial *volumetric* index for the</span>
<span class="doccomment">//! [Human Brain Project]. It is a component of the [Knowledge Graph]</span>
<span class="doccomment">//! service, which provides the spatial anchoring for the metadata</span>
<span class="doccomment">//! registered as well as processes the volumetric queries.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! It is build on top of the Iron Sea database toolkit.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! ## Iron Sea: Database Toolkit</span>
<span class="doccomment">//! **Iron Sea** provides a set of database engine bricks, which can be</span>
<span class="doccomment">//! combined and applied on arbitrary data structures.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! Unlike a traditional database, it does not assume a specific</span>
<span class="doccomment">//! physical structure for the tables nor the records, but relies on the</span>
<span class="doccomment">//! developer to provide a set of extractor functions which are used by</span>
<span class="doccomment">//! the specific indices provided.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! This enables the index implementations to be agnostic from the</span>
<span class="doccomment">//! underlying data structure, and re-used.</span>
<span class="doccomment">//!</span>
<span class="doccomment">//! [Human Brain Project]: http://www.humanbrainproject.eu</span>
<span class="doccomment">//! [Knowledge Graph]: http://www.humanbrainproject.eu/en/explore-the-brain/search/</span>
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">lalrpop_util</span>;