[][src]Struct tantivy::query::Explanation

pub struct Explanation { /* fields omitted */ }

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.


impl Explanation[src]

pub fn new<T: ToString>(description: T, value: f32) -> Explanation[src]

Creates a new explanation object.

pub fn value(&self) -> f32[src]

Returns the value associated to the current node.

pub fn add_detail(&mut self, child_explanation: Explanation)[src]

Add some detail, explaining some part of the current node formula.

Details are treated as child of the current node.

pub fn add_const<T: ToString>(&mut self, name: T, value: f32)[src]

Shortcut for self.details.push(Explanation::new(name, value));

pub fn to_pretty_json(&self) -> String[src]

Returns an indented json representation of the explanation tree for debug usage.

Trait Implementations

impl Clone for Explanation[src]

impl Serialize for Explanation[src]

Auto Trait Implementations

Blanket Implementations

impl<T> Fruit for T where
    T: Send + Downcast

impl<T, U> Into<U> for T where
    U: From<T>, 

impl<T> From<T> for T[src]

impl<T> ToOwned for T where
    T: Clone

type Owned = T

The resulting type after obtaining ownership.

impl<T, U> TryFrom<U> for T where
    U: Into<T>, 

type Error = Infallible

The type returned in the event of a conversion error.

impl<T, U> TryInto<U> for T where
    U: TryFrom<T>, 

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.

impl<T> Borrow<T> for T where
    T: ?Sized

impl<T> BorrowMut<T> for T where
    T: ?Sized

impl<T> Any for T where
    T: 'static + ?Sized

impl<T> Erased for T[src]

impl<T> Downcast for T where
    T: Any

impl<T> DowncastSync for T where
    T: Send + Sync + Any