Struct PGMIndex 

pub struct PGMIndex {
    pub segments: Vec<Segment>,
    pub top_level: Option<Vec<Segment>>,
    pub epsilon: usize,
}

Fields

segments: Vec<Segment>

top_level: Option<Vec<Segment>>

epsilon: usize

Implementations

impl PGMIndex

pub fn build(keys: &[u64], epsilon: usize) -> Result<Self, PGMIndexError>

pub fn build_unsafe(keys: &[u64], epsilon: usize) -> Result<Self, PGMIndexError>

Build the index without safety checks for invariants the algorithm relies for the algorithm to be accurate.

pub fn search(&self, key: u64) -> (usize, usize)

Returns the index range [lo, hi] where key may appear. This range is guaranteed to contain the key “if” it exists.

pub fn to_bytes(&self) -> Result<AlignedVec, Error>

pub fn as_archived(bytes: &[u8]) -> Result<&Archived<PGMIndex>, Error>

Provides zero-copy access to the archived form. Lifetime is tied to bytes.

pub unsafe fn as_archived_unchecked(bytes: &[u8]) -> &Archived<PGMIndex>

Unsafely access the archived index without bounds or validation. Use only when buffer is known to be valid.

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

Deserialize from archived bytes back into a heap-owned PGMIndex.

Trait Implementations

impl Archive for PGMIndex

where Vec<Segment>: Archive, Option<Vec<Segment>>: Archive, usize: Archive,

const COPY_OPTIMIZATION: CopyOptimization<Self>

An optimization flag that allows the bytes of this type to be copied directly to a writer instead of calling serialize.

type Archived = ArchivedPGMIndex

The archived representation of this type.

type Resolver = PGMIndexResolver

The resolver for this type. It must contain all the additional information from serializing needed to make the archived type from the normal type.

fn resolve(&self, resolver: Self::Resolver, out: Place<Self::Archived>)

Creates the archived version of this value at the given position and writes it to the given output.

impl Debug for PGMIndex

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

Formats the value using the given formatter.

impl<__D: Fallible + ?Sized> Deserialize<PGMIndex, __D> for Archived<PGMIndex>

where Vec<Segment>: Archive, <Vec<Segment> as Archive>::Archived: Deserialize<Vec<Segment>, __D>, Option<Vec<Segment>>: Archive, <Option<Vec<Segment>> as Archive>::Archived: Deserialize<Option<Vec<Segment>>, __D>, usize: Archive, <usize as Archive>::Archived: Deserialize<usize, __D>,

fn deserialize( &self, deserializer: &mut __D, ) -> Result<PGMIndex, <__D as Fallible>::Error>

Deserializes using the given deserializer

impl<__S: Fallible + ?Sized> Serialize<__S> for PGMIndex

where Vec<Segment>: Serialize<__S>, Option<Vec<Segment>>: Serialize<__S>, usize: Serialize<__S>,

fn serialize( &self, serializer: &mut __S, ) -> Result<<Self as Archive>::Resolver, <__S as Fallible>::Error>

Writes the dependencies for the object and returns a resolver that can create the archived type.