Struct ObjectRef

pub struct ObjectRef<'a, T: RTreeObject> { /* private fields */ }

An RTreeObject that is a possibly short-lived reference to another object.

Sometimes it can be useful to build an [RTree] that does not own its constituent objects but references them from elsewhere. Wrapping the bare references with this combinator makes this possible.

Note: the wrapper implements RTreeObject and referenced object T can be accessed via an implementation of Deref<Target=T>.

Implementations

impl<'a, T: RTreeObject> ObjectRef<'a, T>

pub fn new(inner: &'a T) -> Self

Create a new ObjectRef struct using the object.

Trait Implementations

impl<'a, T: Clone + RTreeObject> Clone for ObjectRef<'a, T>

fn clone(&self) -> ObjectRef<'a, T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a, T: Debug + RTreeObject> Debug for ObjectRef<'a, T>

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

Formats the value using the given formatter.

impl<'a, T: RTreeObject> Deref for ObjectRef<'a, T>

type Target = T

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'a, T: Hash + RTreeObject> Hash for ObjectRef<'a, 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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<'a, T: Ord + RTreeObject> Ord for ObjectRef<'a, T>

fn cmp(&self, other: &ObjectRef<'a, T>) -> Ordering

This method returns an Ordering between self and other.

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

where Self: Sized,

Compares and returns the maximum of two values.

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

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl<'a, T: PartialEq + RTreeObject> PartialEq for ObjectRef<'a, T>

fn eq(&self, other: &ObjectRef<'a, T>) -> 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, T: PartialOrd + RTreeObject> PartialOrd for ObjectRef<'a, T>

fn partial_cmp(&self, other: &ObjectRef<'a, T>) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'a, T: PointDistance> PointDistance for ObjectRef<'a, T>

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

Returns the squared distance between an object and 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<'a, T: RTreeObject> RTreeObject for ObjectRef<'a, T>

type Envelope = <T as RTreeObject>::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<'a, T: Copy + RTreeObject> Copy for ObjectRef<'a, T>

impl<'a, T: Eq + RTreeObject> Eq for ObjectRef<'a, T>

impl<'a, T: RTreeObject> StructuralPartialEq for ObjectRef<'a, T>