Struct LoadProfile 

pub struct LoadProfile { /* private fields */ }

Which components of a read-only segment a specific request needs warmed.

Built from the request via the for_* constructors; consumed through the placement methods, which return None to keep the persisted-config placement and Some([Populate::No]) to park the component cold.

Implementations

impl LoadProfile

pub fn for_scroll( filter: Option<&Filter>, order_by_key: Option<&JsonPath>, with_payload: bool, ) -> Self

Profile of a scroll: no scoring, so every vector component loads cold; only the field indexes the filter and order_by read stay warm.

pub fn for_search( vector_name: &str, filter: Option<&Filter>, with_payload: bool, ) -> Self

Profile of a (core) search: the queried vector keeps its configured placement — storage, index and quantized vectors — and the filter’s field indexes stay warm.

pub fn for_retrieve() -> Self

Profile of a retrieve by ids: a handful of point-level random reads, everything serves fine cold.

pub fn merge(&mut self, other: LoadProfile)

Fold another request’s profile into this one: a component either request needs warm stays warm. This builds the profile of a composite query — e.g. a hybrid search running one core search per vector — from its parts’ profiles.

The union is sound because every placement method is monotone in the warm sets: growing them only ever turns “park cold” into “keep the configured placement”, so the merged profile dominates each input and no component a sub-request touches is demoted. It is also minimal: nothing is warmed that no part asked for.

Combine multiple profiles with reduce, not fold with a starting profile: merge’s identity element is the coldest profile (empty warm sets), which is the opposite of passing no profile at all (everything warm per config) — there is deliberately no empty()/Default constructor to blur that distinction.

pub fn payload_storage_placement(&self) -> Option<Populate>

Placement override for the payload storage.

pub fn vector_storage_placement(&self, vector_name: &str) -> Option<Populate>

Placement override for the (dense or sparse) vector storage of vector_name.

pub fn quantized_vectors_placement(&self, vector_name: &str) -> Option<Populate>

Placement override for the quantized vectors of vector_name.

Demotes even a pinned placement: within the immutable layout the RAM and mmap loaders share the on-disk format, so a demoted pinned config opens the lazy mmap loaders instead of reading the data in full.

pub fn vector_index_placement(&self, vector_name: &str) -> Option<Populate>

Placement override for the (dense or sparse) vector index of vector_name.

Demotes even a pinned placement: the immutable-RAM and mmap sparse indexes share the on-disk format, so a demoted pinned config opens the lazy mmap index instead of reading the data in full (like Self::quantized_vectors_placement).

For the HNSW index a cold override goes further and defers the graph load: on a remote backend even a cold graph load must mirror the whole links file (GraphLinksView requires one contiguous slice), so the only way not to fetch it is not to load it. The graph loads on first use (with the demoted cold placement), keeping the profile’s contract — every request the segment can serve still works, just colder.

pub fn payload_index_placement(&self, field: &JsonPath) -> Option<Populate>

Placement override for the payload index of field.

Matches the query path, which resolves a condition against the index of the condition’s exact key: only exact-key matches stay warm.

Trait Implementations

impl Clone for LoadProfile

fn clone(&self) -> LoadProfile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LoadProfile

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

Formats the value using the given formatter.

impl Eq for LoadProfile

impl PartialEq for LoadProfile

fn eq(&self, other: &LoadProfile) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for LoadProfile