Skip to main content

Index

Struct Index 

Source
pub struct Index<T> { /* private fields */ }
Expand description

The index: items of type T filed under their box.

Implementations§

Source§

impl<T> Index<T>

Source

pub fn new() -> Self

An empty index.

Source

pub fn build(items: Vec<(Rect, T)>) -> Self

An index built at once over items.

Source

pub fn len(&self) -> usize

How many items it holds, in the tree and in the overflow.

Source

pub fn is_empty(&self) -> bool

No item at all.

Source

pub fn overflow(&self) -> usize

How many items wait in the overflow list.

Source

pub fn rebuilds(&self) -> usize

How many times the tree was packed (the build counts).

Source

pub fn needs_rebuild(&self) -> bool

The overflow has outgrown its share: more than OVERFLOW_FLOOR items and more than a quarter of the tree.

Source

pub fn insert(&mut self, rect: Rect, item: T)

Add an item. It is found by the very next query; the tree is packed again when the overflow has outgrown its share (Self::needs_rebuild).

Source

pub fn rebuild(&mut self)

Pack every item into a fresh tree and empty the overflow.

Source

pub fn query(&self, window: &Rect) -> Vec<&T>

Every item whose box meets window, the tree’s and the overflow’s - the set a linear scan gives, in no particular order.

Source

pub fn visit<'a>(&'a self, window: &Rect, found: &mut dyn FnMut(&'a T))

Self::query, calling found for each instead of collecting.

Trait Implementations§

Source§

impl<T: Clone> Clone for Index<T>

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl<T: Debug> Debug for Index<T>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<T> Default for Index<T>

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

§

impl<T> Freeze for Index<T>
where Vec<(Rect, T)>: Freeze,

§

impl<T> RefUnwindSafe for Index<T>
where Vec<(Rect, T)>: RefUnwindSafe,

§

impl<T> Send for Index<T>
where Vec<(Rect, T)>: Send,

§

impl<T> Sync for Index<T>
where Vec<(Rect, T)>: Sync,

§

impl<T> Unpin for Index<T>
where Vec<(Rect, T)>: Unpin,

§

impl<T> UnsafeUnpin for Index<T>
where Vec<(Rect, T)>: UnsafeUnpin,

§

impl<T> UnwindSafe for Index<T>
where Vec<(Rect, T)>: UnwindSafe,

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more