Struct RTreeMetadata 

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

Common metadata to describe an RTree

You can use the metadata to infer the total byte size of a tree given the provided criteria. See data_buffer_length.

Implementations

impl<N: IndexableNum> RTreeMetadata<N>

pub fn new(num_items: u32, node_size: u16) -> Self

Construct a new RTreeMetadata from a number of items and node size.

pub fn from_slice(data: &[u8]) -> Result<Self, GeoIndexError>

Construct a new RTreeMetadata from an existing byte slice conforming to the “flatbush ABI”, such as what [RTreeBuilder] generates.

pub fn node_size(&self) -> u16

The maximum number of items per node.

pub fn num_items(&self) -> u32

The number of items indexed in the tree.

pub fn num_nodes(&self) -> usize

The total number of nodes at all levels in the tree.

pub 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]].

pub fn data_buffer_length(&self) -> usize

The number of bytes that an RTree with this metadata would have.

use geo_index::rtree::RTreeMetadata;

let metadata = RTreeMetadata::<f64>::new(25000, 16);
assert_eq!(metadata.data_buffer_length(), 960_092);

pub fn boxes_slice<'a>(&self, data: &'a [u8]) -> &'a [N]

Access the slice of boxes from the data buffer this metadata represents.

pub fn indices_slice<'a>(&self, data: &'a [u8]) -> Indices<'a>

Access the slice of indices from the data buffer this metadata represents.

Trait Implementations

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

fn clone(&self) -> RTreeMetadata<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 RTreeMetadata<N>

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

Formats the value using the given formatter.

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

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