Skip to main content

MeasurementCache

Struct MeasurementCache 

Source
pub struct MeasurementCache { /* private fields */ }
Expand description

Cache for storing measured item sizes keyed by VirtualKey.

Maintains a mapping from item keys to their actual measured dimensions. Using keys instead of indices means measured sizes follow items across reorders when a custom key extractor is used.

Implementations§

Source§

impl MeasurementCache

Source

pub fn new(initial_estimate: f64) -> Self

Creates a new empty measurement cache.

§Parameters
  • initial_estimate: The default size estimate used before measurements arrive.
Source

pub fn record( &mut self, key: VirtualKey, size: f64, ) -> Result<bool, VirtualizerError>

Records a measured size for the given item key.

Updates the running average and stores the measurement. If a measurement already exists for this key, it is replaced.

§Parameters
  • key: The item key to record a measurement for.
  • size: The measured size in pixels.
§Returns
  • Ok(bool): True if the measurement changed the stored value.
  • Err(VirtualizerError): If the size is invalid.
§Errors
  • Returns MeasurementError if size is negative, NaN, or infinite.
Source

pub fn get(&self, key: &VirtualKey) -> Option<f64>

Retrieves the measured size for a given key.

§Parameters
  • key: The item key to look up.
§Returns
  • Option<f64>: The measured size if available.
Source

pub fn average(&self) -> f64

Returns the current average of all measured sizes.

§Returns
  • f64: The running average size.
Source

pub fn count(&self) -> usize

Returns the total number of stored measurements.

§Returns
  • usize: The count of recorded measurements.
Source

pub fn clear(&mut self, initial_estimate: f64)

Clears all stored measurements and resets the average.

§Parameters
  • initial_estimate: The new default size estimate after clearing.
Source

pub fn remove(&mut self, key: &VirtualKey) -> Option<f64>

Removes the measurement for a specific key.

§Parameters
  • key: The item key whose measurement should be removed.
§Returns
  • Option<f64>: The removed measurement if it existed.

Trait Implementations§

Source§

impl Clone for MeasurementCache

Source§

fn clone(&self) -> MeasurementCache

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for MeasurementCache

Source§

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

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

impl Default for MeasurementCache

Source§

fn default() -> Self

Returns a default measurement cache with a 50px estimate.

Auto Trait Implementations§

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, 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 = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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.