Struct rstar::primitives::GeomWithData

pub struct GeomWithData<R: RTreeObject, T> {
    pub data: T,
    /* private fields */
}

An RTreeObject with a geometry and some associated data that can be inserted into an r-tree.

Often, adding metadata (like a database ID) to a geometry is required before adding it into an r-tree. This struct removes some of the boilerplate required to do so.

Note: while the container itself implements RTreeObject, you will have to go through its geom method in order to access geometry-specific methods.

Example

use rstar::{RTree, PointDistance};
use rstar::primitives::GeomWithData;

type RestaurantLocation = GeomWithData<[f64; 2], &'static str>;

let mut restaurants = RTree::new();
restaurants.insert(RestaurantLocation::new([0.3, 0.2], "Pete's Pizza Place"));
restaurants.insert(RestaurantLocation::new([-0.8, 0.0], "The Great Steak"));
restaurants.insert(RestaurantLocation::new([0.2, -0.2], "Fishy Fortune"));

let my_location = [0.0, 0.0];

// Now find the closest restaurant!
let place = restaurants.nearest_neighbor(&my_location).unwrap();
println!("Let's go to {}", place.data);
println!("It's really close, only {} miles", place.distance_2(&my_location));

Fields

data: T

Data to be associated with the geometry being stored in the RTree.

Implementations

impl<R: RTreeObject, T> GeomWithData<R, T>

pub fn new(geom: R, data: T) -> Self

Create a new GeomWithData struct using the provided geometry and data.

pub fn geom(&self) -> &R

Get a reference to the container’s geometry.

Trait Implementations

impl<R: Clone + RTreeObject, T: Clone> Clone for GeomWithData<R, T>

fn clone(&self) -> GeomWithData<R, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<R: Debug + RTreeObject, T: Debug> Debug for GeomWithData<R, T>

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

Formats the value using the given formatter.

impl<R: Default + RTreeObject, T: Default> Default for GeomWithData<R, T>

fn default() -> GeomWithData<R, T>

Returns the “default value” for a type.

impl<R: Hash + RTreeObject, T: Hash> Hash for GeomWithData<R, T>

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl<R: Ord + RTreeObject, T: Ord> Ord for GeomWithData<R, T>

fn cmp(&self, other: &GeomWithData<R, T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

Restrict a value to a certain interval.

impl<R: PartialEq + RTreeObject, T: PartialEq> PartialEq<GeomWithData<R, T>> for GeomWithData<R, T>

fn eq(&self, other: &GeomWithData<R, T>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &GeomWithData<R, T>) -> bool

This method tests for !=.

impl<R: PartialOrd + RTreeObject, T: PartialOrd> PartialOrd<GeomWithData<R, T>> for GeomWithData<R, T>

fn partial_cmp(&self, other: &GeomWithData<R, T>) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

This method tests less than (for self and other) and is used by the < operator.

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

This method tests less than or equal to (for self and other) and is used by the <= operator.

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

This method tests greater than (for self and other) and is used by the > operator.

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

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<R: PointDistance, T> PointDistance for GeomWithData<R, T>

fn distance_2(
    &self,
    point: &<Self::Envelope as Envelope>::Point
) -> <<Self::Envelope as Envelope>::Point as Point>::Scalar

Returns the squared euclidean distance between an object to a point.

fn contains_point(&self, p: &<Self::Envelope as Envelope>::Point) -> bool

Returns true if a point is contained within this object.

fn distance_2_if_less_or_equal(
    &self,
    point: &<Self::Envelope as Envelope>::Point,
    max_distance_2: <<Self::Envelope as Envelope>::Point as Point>::Scalar
) -> Option<<<Self::Envelope as Envelope>::Point as Point>::Scalar>

Returns the squared distance to this object, or None if the distance is larger than a given maximum value.

impl<R: RTreeObject, T> RTreeObject for GeomWithData<R, T>

type Envelope = R::Envelope

The object’s envelope type. Usually, AABB will be the right choice. This type also defines the object’s dimensionality.

fn envelope(&self) -> Self::Envelope

Returns the object’s envelope.

impl<R: Copy + RTreeObject, T: Copy> Copy for GeomWithData<R, T>

impl<R: Eq + RTreeObject, T: Eq> Eq for GeomWithData<R, T>

impl<R: RTreeObject, T> StructuralEq for GeomWithData<R, T>

impl<R: RTreeObject, T> StructuralPartialEq for GeomWithData<R, T>