Struct tantivy::DocAddress [−][src]
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
.
Methods
impl DocAddress
[src]
impl DocAddress
pub fn segment_ord(&self) -> SegmentLocalId
[src]
pub fn segment_ord(&self) -> SegmentLocalId
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]
pub fn doc(&self) -> DocId
Return the segment local DocId
Trait Implementations
impl Debug for DocAddress
[src]
impl Debug for DocAddress
fn fmt(&self, f: &mut Formatter) -> Result
[src]
fn fmt(&self, f: &mut Formatter) -> Result
Formats the value using the given formatter. Read more
impl Clone for DocAddress
[src]
impl Clone for DocAddress
fn clone(&self) -> DocAddress
[src]
fn clone(&self) -> DocAddress
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
impl Copy for DocAddress
[src]
impl Copy for DocAddress
impl PartialEq for DocAddress
[src]
impl PartialEq for DocAddress
fn eq(&self, other: &DocAddress) -> bool
[src]
fn eq(&self, other: &DocAddress) -> bool
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, other: &DocAddress) -> bool
[src]
fn ne(&self, other: &DocAddress) -> bool
This method tests for !=
.
impl Eq for DocAddress
[src]
impl Eq for DocAddress
impl PartialOrd for DocAddress
[src]
impl PartialOrd for DocAddress
fn partial_cmp(&self, other: &DocAddress) -> Option<Ordering>
[src]
fn partial_cmp(&self, other: &DocAddress) -> Option<Ordering>
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, other: &DocAddress) -> bool
[src]
fn lt(&self, other: &DocAddress) -> bool
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, other: &DocAddress) -> bool
[src]
fn le(&self, other: &DocAddress) -> bool
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, other: &DocAddress) -> bool
[src]
fn gt(&self, other: &DocAddress) -> bool
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, other: &DocAddress) -> bool
[src]
fn ge(&self, other: &DocAddress) -> bool
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Ord for DocAddress
[src]
impl Ord for DocAddress
fn cmp(&self, other: &DocAddress) -> Ordering
[src]
fn cmp(&self, other: &DocAddress) -> Ordering
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
fn max(self, other: Self) -> Self
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
fn min(self, other: Self) -> Self
Compares and returns the minimum of two values. Read more
Auto Trait Implementations
impl Send for DocAddress
impl Send for DocAddress
impl Sync for DocAddress
impl Sync for DocAddress