Struct tantivy::SegmentMeta [−][src]
pub struct SegmentMeta { /* fields omitted */ }
SegmentMeta
contains simple meta information about a segment.
For instance the number of docs it contains, how many are deleted, etc.
Methods
impl SegmentMeta
[src]
impl SegmentMeta
pub fn all() -> Vec<SegmentMeta>
[src]
pub fn all() -> Vec<SegmentMeta>
Lists all living SegmentMeta
object at the time of the call.
pub fn id(&self) -> SegmentId
[src]
pub fn id(&self) -> SegmentId
Returns the segment id.
pub fn num_deleted_docs(&self) -> u32
[src]
pub fn num_deleted_docs(&self) -> u32
Returns the number of deleted documents.
pub fn list_files(&self) -> HashSet<PathBuf>
[src]
pub fn list_files(&self) -> HashSet<PathBuf>
Returns the list of files that are required for the segment meta.
This is useful as the way tantivy removes files is by removing all files that have been created by tantivy and are not used by any segment anymore.
pub fn relative_path(&self, component: SegmentComponent) -> PathBuf
[src]
pub fn relative_path(&self, component: SegmentComponent) -> PathBuf
Returns the relative path of a component of our segment.
It just joins the segment id with the extension associated to a segment component.
pub fn max_doc(&self) -> u32
[src]
pub fn max_doc(&self) -> u32
Return the highest doc id + 1
If there are no deletes, then num_docs = max_docs and all the doc ids contains in this segment are exactly (0..max_doc).
pub fn num_docs(&self) -> u32
[src]
pub fn num_docs(&self) -> u32
Return the number of documents in the segment.
pub fn delete_opstamp(&self) -> Option<u64>
[src]
pub fn delete_opstamp(&self) -> Option<u64>
Returns the opstamp of the last delete operation taken in account in this segment.
pub fn has_deletes(&self) -> bool
[src]
pub fn has_deletes(&self) -> bool
Returns true iff the segment meta contains delete information.
Trait Implementations
impl Clone for SegmentMeta
[src]
impl Clone for SegmentMeta
fn clone(&self) -> SegmentMeta
[src]
fn clone(&self) -> SegmentMeta
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 Debug for SegmentMeta
[src]
impl Debug for SegmentMeta
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
[src]
fn fmt(&self, f: &mut Formatter) -> Result<(), Error>
Formats the value using the given formatter. Read more
impl Serialize for SegmentMeta
[src]
impl Serialize for SegmentMeta
fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
[src]
fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error> where
S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl<'a> Deserialize<'a> for SegmentMeta
[src]
impl<'a> Deserialize<'a> for SegmentMeta
fn deserialize<D>(
deserializer: D
) -> Result<Self, <D as Deserializer<'a>>::Error> where
D: Deserializer<'a>,
[src]
fn deserialize<D>(
deserializer: D
) -> Result<Self, <D as Deserializer<'a>>::Error> where
D: Deserializer<'a>,
Deserialize this value from the given Serde deserializer. Read more
Auto Trait Implementations
impl Send for SegmentMeta
impl Send for SegmentMeta
impl Sync for SegmentMeta
impl Sync for SegmentMeta