Struct SegmentHeader

Source

pub struct SegmentHeader {
    pub segment_id: SegmentId,
    pub doc_count: u32,
    pub max_doc: u32,
    pub components: Vec<ComponentOffset>,
    pub fields: Vec<FieldMeta>,
    pub parent_bitset: Option<Vec<bool>>,
}

Expand description

The segment header: fixed fields + component offsets + field metadata.

Fields§

§segment_id: SegmentId§doc_count: u32§max_doc: u32§components: Vec<ComponentOffset>§fields: Vec<FieldMeta>§parent_bitset: Option<Vec<bool>>

Parent bitset: if present, indicates which doc IDs are parent docs (vs nested hidden docs). One byte per doc (0=nested, 1=parent).

Implementations§

Source §

impl SegmentHeader

Source

pub fn to_bytes(&self) -> Vec<u8> ⓘ

Serialize the header to bytes (including magic and checksum).

Source

pub fn from_bytes(data: &[u8]) -> Result<(Self, usize)>

Deserialize a header from the beginning of a segment byte slice. Returns (header, bytes_consumed).

Source

pub fn component(&self, ct: ComponentType) -> Option<&ComponentOffset>

Find a component by type.

Trait Implementations§

Source §

impl Clone for SegmentHeader

Source §

fn clone(&self) -> SegmentHeader

Returns a duplicate of the value. Read more

1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Source §

impl Debug for SegmentHeader

Source §

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl UnwindSafe for SegmentHeader

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,

Source §

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

Source §

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

Source §

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

Mutably borrows from an owned value. Read more

Source §

impl<T> CloneToUninit for T
where T: Clone,

Source §

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)

Performs copy-assignment from self to dest. Read more

Source §

impl<T> From<T> for T

Source §

fn from(t: T) -> T

Returns the argument unchanged.

Source §

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

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.

Source §

impl<T> IntoEither for T

Source §

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more

Source §