Struct StreamIndex3D 

pub struct StreamIndex3D<R> { /* private fields */ }

Available on crate feature stream only.

Streaming reader for a 3D f64 packed spatial index.

The 3D counterpart of StreamIndex2D: it shares the same open, validation, directory prefetch, and coalesced traversal, differing only in the 48-byte box record. See StreamIndex2D for the streaming model.

Implementations

impl<R: AsyncRangeReader> StreamIndex3D<R>

Streaming reader for a 3D f64 index over async I/O. See StreamIndex2D’s async methods. Behind the async feature.

pub async fn open_async(reader: R) -> Result<Self, StreamError>

Available on crate feature async only.

Open and validate a 3D f64 index from an async reader.

pub async fn open_with_limits_async( reader: R, limits: StreamLimits, ) -> Result<Self, StreamError>

Available on crate feature async only.

Open from an async reader with per-query StreamLimits.

pub async fn search_async( &self, query: Box3D, ) -> Result<Vec<usize>, StreamError>

Available on crate feature async only.

Stream the indices of every item whose box intersects query.

pub async fn search_payloads_async( &self, query: Box3D, ) -> Result<Vec<(usize, Vec<u8>)>, StreamError>

Available on crate feature async only.

Stream (item index, payload blob) for every item intersecting query.

pub fn has_payload_async(&self) -> bool

Available on crate feature async only.

Whether this index was written with a payload section.

impl<R> StreamIndex3D<R>

pub fn into_directory(self) -> (StreamDirectory, R)

Split off the reader, keeping the reusable StreamDirectory. No I/O.

pub fn from_directory( dir: &StreamDirectory, reader: R, ) -> Result<Self, StreamError>

Rebuild a 3D f64 index from a cached directory and a fresh reader. No I/O.

pub fn from_directory_with_limits( dir: &StreamDirectory, reader: R, limits: StreamLimits, ) -> Result<Self, StreamError>

from_directory with per-query StreamLimits.

impl<R: RangeReader> StreamIndex3D<R>

pub fn open(reader: R) -> Result<Self, StreamError>

Open and validate a 3D f64 index from reader.

pub fn open_with_limits( reader: R, limits: StreamLimits, ) -> Result<Self, StreamError>

Open with per-query cost StreamLimits. See StreamIndex2D::open_with_limits.

pub fn num_items(&self) -> usize

Number of indexed items.

pub fn is_empty(&self) -> bool

Whether the index has no items.

pub fn node_size(&self) -> usize

Packed node size of the index.

pub fn extent(&self) -> Option<Box3D>

Total extent of all indexed items, or None for an empty index. Read from the cached root box, so this costs no I/O.

pub fn visit<F: FnMut(usize)>( &self, query: Box3D, visitor: F, ) -> Result<(), StreamError>

Stream the indices of every item whose box intersects query, passing each to visitor. Fallible; see StreamIndex2D::visit.

pub fn search(&self, query: Box3D) -> Result<Vec<usize>, StreamError>

Stream the indices of every item whose box intersects query.

pub fn search_into( &self, query: Box3D, out: &mut Vec<usize>, ) -> Result<(), StreamError>

Like search, but appends into a reused buffer.

pub fn has_payload(&self) -> bool

Whether this index was written with a payload section.

pub fn visit_payloads<F: FnMut(usize, &[u8])>( &self, query: Box3D, visitor: F, ) -> Result<(), StreamError>

Visit (item index, payload blob) for every item intersecting query. See StreamIndex2D::visit_payloads.

pub fn search_payloads( &self, query: Box3D, ) -> Result<Vec<(usize, Vec<u8>)>, StreamError>

Collect (item index, payload blob) for every item intersecting query.