Struct tantivy::DocAddress

pub struct DocAddress {
    pub segment_ord: SegmentOrdinal,
    pub doc_id: DocId,
}

DocAddress contains all the necessary information to identify a document given a Searcher object.

It consists of an id identifying its segment, and a segment-local DocId.

The id used for the segment is actually an ordinal in the list of Segments held by a Searcher.

Fields

segment_ord: SegmentOrdinal

The segment ordinal id that identifies the segment hosting the document in the Searcher it is called from.

doc_id: DocId

The segment-local DocId.

Implementations

impl DocAddress

pub fn new(segment_ord: SegmentOrdinal, doc_id: DocId) -> DocAddress

Creates a new DocAddress from the segment/docId pair.

Trait Implementations

impl Clone for DocAddress

fn clone(&self) -> DocAddress

Returns a copy of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DocAddress

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Hash for DocAddress

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H)where
    H: Hasher,

Feeds a slice of this type into the given [Hasher].

impl Ord for DocAddress

fn cmp(&self, other: &DocAddress) -> Ordering

This method returns an [Ordering] between self and other.

const fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

const fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

const fn clamp(self, min: Self, max: Self) -> Selfwhere
    Self: PartialOrd<Self>,

Restrict a value to a certain interval.

impl PartialEq<DocAddress> for DocAddress

fn eq(&self, other: &DocAddress) -> bool

This method tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd<DocAddress> for DocAddress

fn partial_cmp(&self, other: &DocAddress) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

const fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

const fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

const fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

const fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Copy for DocAddress

impl Eq for DocAddress

impl StructuralEq for DocAddress

impl StructuralPartialEq for DocAddress