Struct tantivy::SegmentMeta

source · [−]

pub struct SegmentMeta { /* private fields */ }

Expand description

SegmentMeta contains simple meta information about a segment.

For instance the number of docs it contains, how many are deleted, etc.

Implementations

source

impl SegmentMeta

source

pub fn id(&self) -> SegmentId

Returns the segment id.

source

pub fn untrack_temp_docstore(&self)

Removes the Component::TempStore from the alive list and therefore marks the temp docstore file to be deleted by the garbage collection.

source

pub fn num_deleted_docs(&self) -> u32

Returns the number of deleted documents.

source

pub fn list_files(&self) -> HashSet<PathBuf>

Returns the list of files that are required for the segment meta. Note: Some of the returned files may not exist depending on the state of the segment.

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.

source

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 with a segment component.

source

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

source

pub fn num_docs(&self) -> u32

Return the number of documents in the segment.

source

pub fn delete_opstamp(&self) -> Option<Opstamp>

Returns the Opstamp of the last delete operation taken in account in this segment.

source

pub fn has_deletes(&self) -> bool

Returns true iff the segment meta contains delete information.

Trait Implementations

source

impl Clone for SegmentMeta

source

fn clone(&self) -> SegmentMeta

Returns a copy of the value. Read more

1.0.0

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

Performs copy-assignment from source. Read more

source

impl Debug for SegmentMeta

source

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

Formats the value using the given formatter. Read more

source

impl From<TrackedObject<InnerSegmentMeta>> for SegmentMeta

source

fn from(tracked: TrackedObject<InnerSegmentMeta>) -> SegmentMeta

Converts to this type from the input type.

source

impl Serialize for SegmentMeta

source

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

Auto Trait Implementations

impl RefUnwindSafe for SegmentMeta

impl Send for SegmentMeta

impl Sync for SegmentMeta

impl Unpin for SegmentMeta

impl UnwindSafe for SegmentMeta

Blanket Implementations

impl<T> Any for Twhere
T: 'static + ?Sized,

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<T> Downcast for Twhere
T: Any,

source

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

Convert Box<dyn Trait> (where Trait: Downcast) to Box<dyn Any>. Box<dyn Any> can then be further downcast into Box<ConcreteType> where ConcreteType implements Trait. Read more

source

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

Convert Rc<Trait> (where Trait: Downcast) to Rc<Any>. Rc<Any> can then be further downcast into Rc<ConcreteType> where ConcreteType implements Trait. Read more

source

fn as_any(&self) -> &(dyn Any + 'static)

Convert &Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &Any’s vtable from &Trait’s. Read more

source

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

Convert &mut Trait (where Trait: Downcast) to &Any. This is needed since Rust cannot generate &mut Any’s vtable from &mut Trait’s. Read more

source

impl<T> DowncastSync for Twhere
T: Any + Send + Sync,

source

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

Convert Arc<Trait> (where Trait: Downcast) to Arc<Any>. Arc<Any> can then be further downcast into Arc<ConcreteType> where ConcreteType implements Trait. Read more

impl<T> From<T> for T

const: unstable

fn from(t: T) -> T

Returns the argument unchanged.

impl<T, U> Into for Twhere
U: From<T>,

const: unstable

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of [From]<T> for U chooses to do.

source

impl<T> Pointable for T

source

const ALIGN: usize = mem::align_of::<T>()

The alignment of pointer.

type Init = T

The type for initializers.

source

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more

source

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more

source

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more

source

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

source

fn vzip(self) -> V

source

Struct tantivy::SegmentMeta

Implementations

impl SegmentMeta

pub fn id(&self) -> SegmentId

pub fn untrack_temp_docstore(&self)

pub fn num_deleted_docs(&self) -> u32

pub fn list_files(&self) -> HashSet<PathBuf>

pub fn relative_path(&self, component: SegmentComponent) -> PathBuf

pub fn max_doc(&self) -> u32

pub fn num_docs(&self) -> u32

pub fn delete_opstamp(&self) -> Option<Opstamp>

pub fn has_deletes(&self) -> bool

Trait Implementations

impl Clone for SegmentMeta

fn clone(&self) -> SegmentMeta

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

impl Debug for SegmentMeta

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

impl From<TrackedObject<InnerSegmentMeta>> for SegmentMeta

fn from(tracked: TrackedObject<InnerSegmentMeta>) -> SegmentMeta

impl Serialize for SegmentMeta

fn serialize<S>( &self, serializer: S) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where S: Serializer,

Auto Trait Implementations

impl RefUnwindSafe for SegmentMeta

impl Send for SegmentMeta

impl Sync for SegmentMeta

impl Unpin for SegmentMeta

impl UnwindSafe for SegmentMeta

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> Downcast for Twhere T: Any,

fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>

fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>

fn as_any(&self) -> &(dyn Any + 'static)

fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)

impl<T> DowncastSync for Twhere T: Any + Send + Sync,

fn into_any_arc(self: Arc<T>) -> Arc<dyn Any + Sync + Send + 'static>

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::<T>()

type Init = T

unsafe fn init(init: <T as Pointable>::Init) -> usize

unsafe fn deref<'a>(ptr: usize) -> &'a T

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

unsafe fn drop(ptr: usize)

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<V, T> VZip<V> for Twhere V: MultiLane<T>,

fn vzip(self) -> V

impl<T> Fruit for Twhere T: Send + Downcast,

fn serialize<S>(
&self,
serializer: S
) -> Result<<S as Serializer>::Ok, <S as Serializer>::Error>where
S: Serializer,

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<T> Downcast for Twhere
T: Any,

impl<T> DowncastSync for Twhere
T: Any + Send + Sync,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<V, T> VZip<V> for Twhere
V: MultiLane<T>,

impl<T> Fruit for Twhere
T: Send + Downcast,