[][src]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 in an id identifying its segment, and its segment-local DocId.

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


impl DocAddress[src]

pub fn segment_ord(self) -> SegmentLocalId[src]

Return the segment ordinal. The segment ordinal is an id identifying the segment hosting the document. It is only meaningful, in the context of a searcher.

pub fn doc(self) -> DocId[src]

Return the segment local DocId

Trait Implementations

impl Clone for DocAddress[src]

impl Copy for DocAddress[src]

impl Eq for DocAddress[src]

impl Ord for DocAddress[src]

impl PartialEq<DocAddress> for DocAddress[src]

impl PartialOrd<DocAddress> for DocAddress[src]

impl Debug for DocAddress[src]

impl StructuralPartialEq for DocAddress[src]

impl StructuralEq for DocAddress[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