Struct RTree 

pub struct RTree<N: IndexableNum> { /* private fields */ }

An owned RTree buffer.

Usually this will be created from scratch via RTreeBuilder.

Implementations

impl<N: IndexableNum> RTree<N>

pub fn into_inner(self) -> Vec<u8>

Access the underlying buffer of this RTree.

This buffer can then be persisted and passed to RTreeRef::try_new.

Trait Implementations

impl<N: IndexableNum> AsRef<[u8]> for RTree<N>

fn as_ref(&self) -> &[u8]

Converts this type into a shared reference of the (usually inferred) input type.

impl<N: Clone + IndexableNum> Clone for RTree<N>

fn clone(&self) -> RTree<N>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N: Debug + IndexableNum> Debug for RTree<N>

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

Formats the value using the given formatter.

impl<N: PartialEq + IndexableNum> PartialEq for RTree<N>

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