Skip to main content

PlainMmapBacking

Struct PlainMmapBacking 

Source
pub struct PlainMmapBacking { /* private fields */ }
Expand description

Zero-copy VectorSegmentBacking backed by a plaintext NDVS mmap segment.

Vectors and surrogate IDs are served as slices directly into the mmap region — no allocation on the read path.

§Send + Sync rationale

MmapVectorSegment is declared !Send + !Sync because it holds a *const u8 field (base) pointing into the mmap region. Raw pointers are conservative: the compiler cannot know whether the pointee is safe to share.

The mmap region behind base is:

  • mapped with PROT_READ | MAP_PRIVATE — never mutated through this pointer after construction,
  • valid for exactly the lifetime of the MmapVectorSegment (the descriptor _fd keeps the file open; munmap runs in Drop),
  • not thread-affine — the OS virtual-memory subsystem treats it as a process-global read-only region.

All access to base goes through get_vector / get_surrogate / prefetch, which derive shared borrows (&[f32], &[u8]) that live no longer than &self. No &mut path exists. Multiple threads reading distinct vectors concurrently is safe for the same reason &[T] is Sync.

The Arc<MmapVectorSegment> wrapper ensures the segment (and therefore the mmap region) outlives any &[f32] slice handed out through this type.

SAFETY: given the above invariants, treating PlainMmapBacking as Send + Sync is correct.

Implementations§

Source§

impl PlainMmapBacking

Source

pub fn new(seg: MmapVectorSegment) -> Self

Wrap a MmapVectorSegment that is not yet reference-counted.

MmapVectorSegment holds a *const u8 raw pointer which makes it !Send + !Sync by default. The unsafe impl Send + Sync on PlainMmapBacking (see struct-level doc comment) establishes the safety invariants; clippy cannot see through the Arc to the impl, so we suppress the lint here.

Source

pub fn from_arc(seg: Arc<MmapVectorSegment>) -> Self

Wrap an already reference-counted segment.

Useful when the same segment is shared with other consumers (e.g. a crate::collection::VectorCollection that also owns the segment for direct SIMD scan).

Source

pub fn segment(&self) -> &Arc<MmapVectorSegment>

Access the underlying segment.

Trait Implementations§

Source§

impl Send for PlainMmapBacking

Source§

impl Sync for PlainMmapBacking

Source§

impl VectorSegmentBacking for PlainMmapBacking

Source§

fn len(&self) -> usize

Number of vectors stored in this segment.
Source§

fn dim(&self) -> usize

Dimensionality of each stored vector.
Source§

fn get_vector(&self, id: u32) -> Option<&[f32]>

Fetch one vector by local position id (0..len). Read more
Source§

fn get_surrogate(&self, id: u32) -> Option<u64>

Surrogate id for a local position. Read more
Source§

fn prefetch(&self, id: u32)

Optional prefetch hint. Read more
Source§

fn is_empty(&self) -> bool

Returns true when the segment contains no vectors.

Auto Trait Implementations§

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> ArchivePointee for T

Source§

type ArchivedMetadata = ()

The archived version of the pointer metadata for this type.
Source§

fn pointer_metadata( _: &<T as ArchivePointee>::ArchivedMetadata, ) -> <T as Pointee>::Metadata

Converts some archived metadata to the pointer metadata for itself.
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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> 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> LayoutRaw for T

Source§

fn layout_raw(_: <T as Pointee>::Metadata) -> Result<Layout, LayoutError>

Returns the layout of the type.
Source§

impl<T, N1, N2> Niching<NichedOption<T, N1>> for N2
where T: SharedNiching<N1, N2>, N1: Niching<T>, N2: Niching<T>,

Source§

unsafe fn is_niched(niched: *const NichedOption<T, N1>) -> bool

Returns whether the given value has been niched. Read more
Source§

fn resolve_niched(out: Place<NichedOption<T, N1>>)

Writes data to out indicating that a T is niched.
Source§

impl<T> Pointee for T

Source§

type Metadata = ()

The metadata type for pointers and references to this type.
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<SS, SP> SupersetOf<SS> for SP
where SS: SubsetOf<SP>,

Source§

fn to_subset(&self) -> Option<SS>

The inverse inclusion map: attempts to construct self from the equivalent element of its superset. Read more
Source§

fn is_in_subset(&self) -> bool

Checks if self is actually part of its subset T (and can be converted to it).
Source§

fn to_subset_unchecked(&self) -> SS

Use with care! Same as self.to_subset but without any property checks. Always succeeds.
Source§

fn from_subset(element: &SS) -> SP

The inclusion map: converts self to the equivalent element of its superset.
Source§

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

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

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

The type returned in the event of a conversion error.
Source§

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

Performs the conversion.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more