Struct tantivy::DocAddress

pub struct DocAddress(pub SegmentLocalId, pub 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.

Methods

impl DocAddress

pub fn segment_ord(self) -> SegmentLocalId

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

pub fn doc(self) -> DocId

Return the segment-local DocId

Trait Implementations

impl Clone for DocAddress

fn clone(&self) -> DocAddress

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for DocAddress

impl Debug for DocAddress

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

Formats the value using the given formatter.

impl Eq for DocAddress

impl Ord for DocAddress

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

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 ==.

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

This method tests for !=.

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.

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

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

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

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

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

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

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

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

impl StructuralEq for DocAddress

impl StructuralPartialEq for DocAddress