| <!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="Source of the Rust file `/root/.cargo/git/checkouts/tantivy-65d0bbbddbbd5d02/433372d/src/macros.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>macros.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" href="../../tantivy/index.html"><div class="logo-container"> |
| <img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></div></a></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../tantivy/index.html"> |
| <img src="http://fulmicoton.com/tantivy-logo/tantivy-logo.png" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <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> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| </pre><pre class="rust"><code><span class="doccomment">/// `doc!` is a shortcut that helps building `Document` |
| /// objects. |
| /// |
| /// Assuming that `field1` and `field2` are `Field` instances. |
| /// You can create a document with a value of `value1` for `field1` |
| /// `value2` for `field2`, as follows : |
| /// |
| /// ```c |
| /// doc!( |
| /// field1 => value1, |
| /// field2 => value2, |
| /// ) |
| /// ``` |
| /// |
| /// The value can be a `u64`, a `&str`, a `i64`, or a `String`. |
| /// |
| /// # Warning |
| /// |
| /// The document hence created, is not yet validated against a schema. |
| /// Nothing prevents its user from creating an invalid document missing a |
| /// field, or associating a `String` to a `u64` field for instance. |
| /// |
| /// # Example |
| /// |
| /// ```rust |
| /// use tantivy::schema::{Schema, TEXT, FAST}; |
| /// use tantivy::doc; |
| /// |
| /// //... |
| /// |
| /// # fn main() { |
| /// let mut schema_builder = Schema::builder(); |
| /// let title = schema_builder.add_text_field("title", TEXT); |
| /// let author = schema_builder.add_text_field("text", TEXT); |
| /// let likes = schema_builder.add_u64_field("num_u64", FAST); |
| /// let schema = schema_builder.build(); |
| /// let doc = doc!( |
| /// title => "Life Aquatic", |
| /// author => "Wes Anderson", |
| /// likes => 4u64 |
| /// ); |
| /// # } |
| /// ``` |
| </span><span class="attribute">#[macro_export] |
| </span><span class="macro">macro_rules! </span>doc( |
| () => { |
| { |
| (<span class="macro-nonterminal">$crate::Document::default</span>()) |
| } |
| }; <span class="comment">// avoids a warning due to the useless `mut`. |
| </span>($(<span class="macro-nonterminal">$field</span>:expr => <span class="macro-nonterminal">$value</span>:expr),<span class="kw-2">*</span>) => { |
| { |
| <span class="kw">let </span><span class="kw-2">mut </span>document = <span class="macro-nonterminal">$crate::Document::default</span>(); |
| $( |
| document.add_field_value(<span class="macro-nonterminal">$field</span>, <span class="macro-nonterminal">$value</span>); |
| )* |
| document |
| } |
| }; |
| <span class="comment">// if there is a trailing comma retry with the trailing comma stripped. |
| </span>($(<span class="macro-nonterminal">$field</span>:expr => <span class="macro-nonterminal">$value</span>:expr),+ ,) => { |
| <span class="macro">doc!</span>( $( <span class="macro-nonterminal">$field </span>=> <span class="macro-nonterminal">$value </span>), <span class="kw-2">*</span>) |
| }; |
| ); |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>test { |
| <span class="kw">use </span><span class="kw">crate</span>::schema::{Schema, FAST, TEXT}; |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_doc_basic() { |
| <span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder(); |
| <span class="kw">let </span>title = schema_builder.add_text_field(<span class="string">"title"</span>, TEXT); |
| <span class="kw">let </span>author = schema_builder.add_text_field(<span class="string">"text"</span>, TEXT); |
| <span class="kw">let </span>likes = schema_builder.add_u64_field(<span class="string">"num_u64"</span>, FAST); |
| <span class="kw">let </span>_schema = schema_builder.build(); |
| <span class="kw">let </span>_doc = <span class="macro">doc!</span>( |
| title => <span class="string">"Life Aquatic"</span>, |
| author => <span class="string">"Wes Anderson"</span>, |
| likes => <span class="number">4u64 |
| </span>); |
| } |
| |
| <span class="attribute">#[test] |
| </span><span class="kw">fn </span>test_doc_trailing_comma() { |
| <span class="kw">let </span><span class="kw-2">mut </span>schema_builder = Schema::builder(); |
| <span class="kw">let </span>title = schema_builder.add_text_field(<span class="string">"title"</span>, TEXT); |
| <span class="kw">let </span>author = schema_builder.add_text_field(<span class="string">"text"</span>, TEXT); |
| <span class="kw">let </span>likes = schema_builder.add_u64_field(<span class="string">"num_u64"</span>, FAST); |
| <span class="kw">let </span>_schema = schema_builder.build(); |
| <span class="kw">let </span>_doc = <span class="macro">doc!</span>( |
| title => <span class="string">"Life Aquatic"</span>, |
| author => <span class="string">"Wes Anderson"</span>, |
| likes => <span class="number">4u64</span>, |
| ); |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tantivy" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
