tantivy/columnar/src/comparable_doc.rs

use serde::{Deserialize, Serialize};

/// Contains a feature (field, score, etc.) of a document along with the document address.
///
/// Used only by TopNComputer, which implements the actual comparison via a `Comparator`.
#[derive(Clone, Default, Eq, PartialEq, Serialize, Deserialize)]
pub struct ComparableDoc<T, D> {
    /// The feature of the document. In practice, this is
    /// is a type which can be compared with a `Comparator<T>`.
    pub sort_key: T,
    /// The document address. In practice, this is either a `DocId` or `DocAddress`.
    pub doc: D,
}

impl<T: std::fmt::Debug, D: std::fmt::Debug> std::fmt::Debug for ComparableDoc<T, D> {
    fn fmt(&self, f: &mut std::fmt::Formatter) -> std::fmt::Result {
        f.debug_struct("ComparableDoc")
            .field("feature", &self.sort_key)
            .field("doc", &self.doc)
            .finish()
    }
}