Struct RTreeRef 

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

A reference on an external RTree buffer.

Usually this will be created from an RTree via its as_ref method, but it can also be created from any existing data buffer.

Implementations

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

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

Construct a new RTree from an external byte slice.

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

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

Construct a new RTreeRef without doing any validation

Safety

metadata must be valid for this data buffer.

Trait Implementations

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

fn clone(&self) -> RTreeRef<'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 RTreeRef<'a, N>

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

Formats the value using the given formatter.

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

fn eq(&self, other: &RTreeRef<'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<N: IndexableNum> RTreeIndex<N> for RTreeRef<'_, N>

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

A slice representing all the bounding boxes of all elements contained within this tree, including the bounding boxes of each internal node.

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

A slice representing the indices within the boxes slice, including internal nodes.

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

Access the metadata describing this RTree

fn num_items(&self) -> u32

The total number of items contained in this RTree.

fn num_nodes(&self) -> usize

The total number of nodes in this RTree, including both leaf and intermediate nodes.

fn node_size(&self) -> u16

The maximum number of elements in each node.

fn level_bounds(&self) -> &[usize]

The offsets into RTreeIndex::boxes where each level’s boxes starts and ends. The tree is laid out bottom-up, and there’s an implicit initial 0. So the boxes of the lowest level of the tree are located from boxes[0..self.level_bounds()[0]].

fn num_levels(&self) -> usize

The number of levels (height) of the tree.

fn boxes_at_level(&self, level: usize) -> Result<&[N], GeoIndexError>

The tree is laid out from bottom to top. Level 0 is the base of the tree. Each integer higher is one level higher of the tree.

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

Search an RTree given the provided bounding box.

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

Search an RTree given the provided bounding box.

fn neighbors( &self, x: N, y: N, max_results: Option<usize>, max_distance: Option<N>, ) -> Vec<u32>

Search items in order of distance from the given point.

fn neighbors_with_simple_distance<M: SimpleDistanceMetric<N> + ?Sized>( &self, x: N, y: N, max_results: Option<usize>, max_distance: Option<N>, distance_metric: &M, ) -> Vec<u32>

Search items in order of distance from the given point using a simple distance metric.

fn neighbors_coord( &self, coord: &impl CoordTrait<T = N>, max_results: Option<usize>, max_distance: Option<N>, ) -> Vec<u32>

Search items in order of distance from the given coordinate.

fn intersection_candidates_with_other_tree<'a>( &'a self, other: &'a impl RTreeIndex<N>, ) -> impl Iterator<Item = (u32, u32)> + 'a

Returns an iterator over the indexes of objects in this and another tree that intersect.

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

Access the root node of the RTree for manual traversal.

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