Struct tantivy::fastfield::CompositeFastFieldSerializer

source · [−]

pub struct CompositeFastFieldSerializer { /* private fields */ }

Expand description

CompositeFastFieldSerializer is in charge of serializing fastfields on disk.

Fast fields have different encodings like bit-packing.

FastFieldWriters are in charge of pushing the data to the serializer. The serializer expects to receive the following calls.

new_u64_fast_field(...)
add_val(...)
add_val(...)
add_val(...)
…
close_field()
new_u64_fast_field(...)
add_val(...)
…
close_field()
close()

Implementations

source

impl CompositeFastFieldSerializer

source

pub fn from_write(write: WritePtr) -> Result<CompositeFastFieldSerializer>

Constructor

source

pub fn create_auto_detect_u64_fast_field(
 &mut self,
 field: Field,
 stats: FastFieldStats,
 fastfield_accessor: impl FastFieldDataAccess,
 data_iter_1: impl Iterator<Item = u64>,
 data_iter_2: impl Iterator<Item = u64>
) -> Result<()>

Serialize data into a new u64 fast field. The best compression codec will be chosen automatically.

source

pub fn create_auto_detect_u64_fast_field_with_idx(
 &mut self,
 field: Field,
 stats: FastFieldStats,
 fastfield_accessor: impl FastFieldDataAccess,
 data_iter_1: impl Iterator<Item = u64>,
 data_iter_2: impl Iterator<Item = u64>,
 idx: usize
) -> Result<()>

Serialize data into a new u64 fast field. The best compression codec will be chosen automatically.

source

pub fn new_u64_fast_field(
 &mut self,
 field: Field,
 min_value: u64,
 max_value: u64
) -> Result<BitpackedFastFieldSerializerLegacy<'_, CountingWriter<WritePtr>>>

Start serializing a new u64 fast field

source

pub fn new_u64_fast_field_with_idx(
 &mut self,
 field: Field,
 min_value: u64,
 max_value: u64,
 idx: usize
) -> Result<BitpackedFastFieldSerializerLegacy<'_, CountingWriter<WritePtr>>>

Start serializing a new u64 fast field

source

pub fn new_bytes_fast_field_with_idx(
 &mut self,
 field: Field,
 idx: usize
) -> FastBytesFieldSerializer<'_, CountingWriter<WritePtr>>

Start serializing a new u8 fast field

source

pub fn close(self) -> Result<()>

Closes the serializer

After this call the data must be persistently saved on disk.

Auto Trait Implementations

impl !RefUnwindSafe for CompositeFastFieldSerializer

impl !Send for CompositeFastFieldSerializer

impl !Sync for CompositeFastFieldSerializer

impl Unpin for CompositeFastFieldSerializer

impl !UnwindSafe for CompositeFastFieldSerializer

Blanket Implementations

source

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

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

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

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> Downcast for T where
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> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · source

fn into(self) -> U

Calls U::from(self).

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

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

The alignment of pointer.

type Init = T

The type for initializers.

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

Initializes a with the given initializer. Read more

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

Dereferences the given pointer. Read more

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

Mutably dereferences the given pointer. Read more

unsafe fn drop(ptr: usize)

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

source

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

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct tantivy::fastfield::CompositeFastFieldSerializer

Implementations

impl CompositeFastFieldSerializer

pub fn from_write(write: WritePtr) -> Result<CompositeFastFieldSerializer>

pub fn create_auto_detect_u64_fast_field( &mut self, field: Field, stats: FastFieldStats, fastfield_accessor: impl FastFieldDataAccess, data_iter_1: impl Iterator<Item = u64>, data_iter_2: impl Iterator<Item = u64>) -> Result<()>

pub fn create_auto_detect_u64_fast_field_with_idx( &mut self, field: Field, stats: FastFieldStats, fastfield_accessor: impl FastFieldDataAccess, data_iter_1: impl Iterator<Item = u64>, data_iter_2: impl Iterator<Item = u64>, idx: usize) -> Result<()>

pub fn new_u64_fast_field( &mut self, field: Field, min_value: u64, max_value: u64) -> Result<BitpackedFastFieldSerializerLegacy<'_, CountingWriter<WritePtr>>>

pub fn new_u64_fast_field_with_idx( &mut self, field: Field, min_value: u64, max_value: u64, idx: usize) -> Result<BitpackedFastFieldSerializerLegacy<'_, CountingWriter<WritePtr>>>

pub fn new_bytes_fast_field_with_idx( &mut self, field: Field, idx: usize) -> FastBytesFieldSerializer<'_, CountingWriter<WritePtr>>

pub fn close(self) -> Result<()>

Auto Trait Implementations

impl !RefUnwindSafe for CompositeFastFieldSerializer

impl !Send for CompositeFastFieldSerializer

impl !Sync for CompositeFastFieldSerializer

impl Unpin for CompositeFastFieldSerializer

impl !UnwindSafe for CompositeFastFieldSerializer

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> Downcast for T where 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> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

impl<T> Pointable for T

const ALIGN: usize = mem::align_of::()

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, U> TryFrom<U> for T where U: Into<T>,

type Error = Infallible

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

impl<T, U> TryInto<U> for T where 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 T where V: MultiLane<T>,

fn vzip(self) -> V

pub fn create_auto_detect_u64_fast_field(
&mut self,
field: Field,
stats: FastFieldStats,
fastfield_accessor: impl FastFieldDataAccess,
data_iter_1: impl Iterator<Item = u64>,
data_iter_2: impl Iterator<Item = u64>
) -> Result<()>

pub fn create_auto_detect_u64_fast_field_with_idx(
&mut self,
field: Field,
stats: FastFieldStats,
fastfield_accessor: impl FastFieldDataAccess,
data_iter_1: impl Iterator<Item = u64>,
data_iter_2: impl Iterator<Item = u64>,
idx: usize
) -> Result<()>

pub fn new_u64_fast_field(
&mut self,
field: Field,
min_value: u64,
max_value: u64
) -> Result<BitpackedFastFieldSerializerLegacy<'_, CountingWriter<WritePtr>>>

pub fn new_u64_fast_field_with_idx(
&mut self,
field: Field,
min_value: u64,
max_value: u64,
idx: usize
) -> Result<BitpackedFastFieldSerializerLegacy<'_, CountingWriter<WritePtr>>>

pub fn new_bytes_fast_field_with_idx(
&mut self,
field: Field,
idx: usize
) -> FastBytesFieldSerializer<'_, CountingWriter<WritePtr>>

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

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

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

impl<T> Downcast for T where
T: Any,

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

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

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

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