Struct tantivy::postings::InvertedIndexSerializer [−][src]
InvertedIndexSerializer
is in charge of serializing
postings on disk, in the
.idx
(inverted index).pos
(positions file).term
(term dictionary)
PostingsWriter
are in charge of pushing the data to the
serializer.
The serializer expects to receive the following calls in this order :
set_field(...)
new_term(...)
write_doc(...)
write_doc(...)
write_doc(...)
- ...
close_term()
new_term(...)
write_doc(...)
- ...
close_term()
set_field(...)
- ...
close()
Terms have to be pushed in a lexicographically-sorted order. Within a term, document have to be pushed in increasing order.
A description of the serialization format is available here.
Implementations
impl InvertedIndexSerializer
[src]
pub fn open(segment: &mut Segment) -> Result<InvertedIndexSerializer>
[src]
Open a new PostingsSerializer
for the given segment
pub fn new_field(
&mut self,
field: Field,
total_num_tokens: u64,
fieldnorm_reader: Option<FieldNormReader>
) -> Result<FieldSerializer<'_>>
[src]
&mut self,
field: Field,
total_num_tokens: u64,
fieldnorm_reader: Option<FieldNormReader>
) -> Result<FieldSerializer<'_>>
Must be called before starting pushing terms of a given field.
Loads the indexing options for the given field.
pub fn close(self) -> Result<()>
[src]
Closes the serializer.
Auto Trait Implementations
impl !RefUnwindSafe for InvertedIndexSerializer
[src]
impl !Send for InvertedIndexSerializer
[src]
impl !Sync for InvertedIndexSerializer
[src]
impl Unpin for InvertedIndexSerializer
[src]
impl !UnwindSafe for InvertedIndexSerializer
[src]
Blanket Implementations
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> Borrow<T> for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
[src]
T: ?Sized,
pub fn borrow_mut(&mut self) -> &mut T
[src]
impl<T> Downcast for T where
T: Any,
[src]
T: Any,
pub fn into_any(self: Box<T, Global>) -> Box<dyn Any + 'static, Global>
[src]
pub fn into_any_rc(self: Rc<T>) -> Rc<dyn Any + 'static>
[src]
pub fn as_any(&self) -> &(dyn Any + 'static)
[src]
pub fn as_any_mut(&mut self) -> &mut (dyn Any + 'static)
[src]
impl<T> From<T> for T
[src]
impl<T, U> Into<U> for T where
U: From<T>,
[src]
U: From<T>,
impl<T> Pointable for T
pub const ALIGN: usize
type Init = T
The type for initializers.
pub unsafe fn init(init: <T as Pointable>::Init) -> usize
pub unsafe fn deref<'a>(ptr: usize) -> &'a T
pub unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T
pub unsafe fn drop(ptr: usize)
impl<T, U> TryFrom<U> for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
pub fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T, U> TryInto<U> for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,
type Error = <U as TryFrom<T>>::Error
The type returned in the event of a conversion error.
pub fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>
[src]
impl<V, T> VZip<V> for T where
V: MultiLane<T>,
V: MultiLane<T>,