Struct KDTreeRef 

pub struct KDTreeRef<'a, N: IndexableNum> { /* private fields */ }

A reference on an external KDTree buffer.

Implementations

impl<'a, N: IndexableNum> KDTreeRef<'a, N>

pub fn try_new<T: AsRef<[u8]>>(data: &'a T) -> Result<Self, GeoIndexError>

Construct a new KDTreeRef from an external byte slice.

This byte slice must conform to the “kdbush ABI”, that is, the ABI originally implemented by the JavaScript kdbush library. You can extract such a buffer either via KDTree::into_inner or from the .data attribute of the JavaScript KDBush object.

pub unsafe fn new_unchecked<T: AsRef<[u8]>>( data: &'a T, metadata: KDTreeMetadata<N>, ) -> Result<Self, GeoIndexError>

Construct a new KDTreeRef without doing any validation

Safety

metadata must be valid for this data buffer.

Trait Implementations

impl<'a, N: Clone + IndexableNum> Clone for KDTreeRef<'a, N>

fn clone(&self) -> KDTreeRef<'a, N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a, N: Debug + IndexableNum> Debug for KDTreeRef<'a, N>

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

Formats the value using the given formatter.

impl<N: IndexableNum> KDTreeIndex<N> for KDTreeRef<'_, N>

fn coords(&self) -> &[N]

The underlying raw coordinate buffer of this tree

fn indices(&self) -> Indices<'_>

The underlying raw indices buffer of this tree

fn metadata(&self) -> &KDTreeMetadata<N>

Access the metadata describing this KDTree

fn num_items(&self) -> u32

The number of items in this KDTree

fn node_size(&self) -> u16

The node size of this KDTree

fn range(&self, min_x: N, min_y: N, max_x: N, max_y: N) -> Vec<u32>

Search the index for items within a given bounding box.

fn range_rect(&self, rect: &impl RectTrait<T = N>) -> Vec<u32>

Search the index for items within a given bounding box.

fn within(&self, qx: N, qy: N, r: N) -> Vec<u32>

Search the index for items within a given radius.

fn within_coord(&self, coord: &impl CoordTrait<T = N>, r: N) -> Vec<u32>

Search the index for items within a given radius.

fn root(&self) -> Node<'_, N, Self>

Access the root node of the KDTree for manual traversal.

impl<'a, N: PartialEq + IndexableNum> PartialEq for KDTreeRef<'a, N>

fn eq(&self, other: &KDTreeRef<'a, N>) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<'a, N: IndexableNum> StructuralPartialEq for KDTreeRef<'a, N>