| <!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/query/explanation.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>explanation.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> |
| </pre><pre class="rust"><code><span class="kw">use </span>std::fmt; |
| |
| <span class="kw">use </span>serde::Serialize; |
| |
| <span class="kw">use crate</span>::{DocId, Score, TantivyError}; |
| |
| <span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>does_not_match(doc: DocId) -> TantivyError { |
| TantivyError::InvalidArgument(<span class="macro">format!</span>(<span class="string">"Document #({}) does not match"</span>, doc)) |
| } |
| |
| <span class="doccomment">/// Object describing the score of a given document. |
| /// It is organized in trees. |
| /// |
| /// `.to_pretty_json()` can be useful to print out a human readable |
| /// representation of this tree when debugging a given score. |
| </span><span class="attribute">#[derive(Clone, Serialize)] |
| </span><span class="kw">pub struct </span>Explanation { |
| value: Score, |
| description: String, |
| <span class="attribute">#[serde(skip_serializing_if = <span class="string">"Vec::is_empty"</span>)] |
| </span>details: Vec<Explanation>, |
| context: Vec<String>, |
| } |
| |
| <span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Explanation { |
| <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter) -> fmt::Result { |
| <span class="macro">write!</span>(f, <span class="string">"Explanation({})"</span>, <span class="self">self</span>.to_pretty_json()) |
| } |
| } |
| |
| <span class="kw">impl </span>Explanation { |
| <span class="doccomment">/// Creates a new explanation object. |
| </span><span class="kw">pub fn </span>new<T: ToString>(description: T, value: Score) -> Explanation { |
| Explanation { |
| value, |
| description: description.to_string(), |
| details: <span class="macro">vec!</span>[], |
| context: <span class="macro">vec!</span>[], |
| } |
| } |
| |
| <span class="doccomment">/// Returns the value associated with the current node. |
| </span><span class="kw">pub fn </span>value(<span class="kw-2">&</span><span class="self">self</span>) -> Score { |
| <span class="self">self</span>.value |
| } |
| |
| <span class="doccomment">/// Add some detail, explaining some part of the current node formula. |
| /// |
| /// Details are treated as child of the current node. |
| </span><span class="kw">pub fn </span>add_detail(<span class="kw-2">&mut </span><span class="self">self</span>, child_explanation: Explanation) { |
| <span class="self">self</span>.details.push(child_explanation); |
| } |
| |
| <span class="doccomment">/// Adds some extra context to the explanation. |
| </span><span class="kw">pub fn </span>add_context(<span class="kw-2">&mut </span><span class="self">self</span>, context: String) { |
| <span class="self">self</span>.context.push(context); |
| } |
| |
| <span class="doccomment">/// Shortcut for `self.details.push(Explanation::new(name, value));` |
| </span><span class="kw">pub fn </span>add_const<T: ToString>(<span class="kw-2">&mut </span><span class="self">self</span>, name: T, value: Score) { |
| <span class="self">self</span>.details.push(Explanation::new(name, value)); |
| } |
| |
| <span class="doccomment">/// Returns an indented json representation of the explanation tree for debug usage. |
| </span><span class="kw">pub fn </span>to_pretty_json(<span class="kw-2">&</span><span class="self">self</span>) -> String { |
| serde_json::to_string_pretty(<span class="self">self</span>).unwrap() |
| } |
| } |
| </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> |
