Struct KeyDataMap 

pub struct KeyDataMap<K, V> {
    pub values: BTreeMap1<K, V>,
}

A generic key-value data map with interpolation support.

Stores key-value pairs in a BTreeMap1 for efficient ordered queries and supports various interpolation methods. The map is guaranteed to be non-empty at the type level.

When the interpolation feature is enabled, each value can have an associated interpolation specification for animation curves.

Use the type alias TimeDataMap<V> for time-keyed maps (the common case), or use KeyDataMap<Position, V> for curve-domain maps.

Fields

values: BTreeMap1<K, V>

The key-value pairs with optional interpolation keys.

Guaranteed non-empty by BTreeMap1.

Implementations

impl<K: Ord, V> KeyDataMap<K, V>

pub fn iter(&self) -> impl Iterator<Item = (&K, &V)>

Get an iterator over key-value pairs.

pub fn is_empty(&self) -> bool

Always returns false – BTreeMap1 guarantees at least one entry.

pub fn len(&self) -> usize

Get the number of entries.

pub fn remove(&mut self, key: &K) -> Result<Option<V>>

Remove a sample at the given key.

Returns Ok(Some(value)) if the key existed and was removed, Ok(None) if the key was not found, or Err(LastSample) if removing the key would empty the map.

impl<K: Ord, V> KeyDataMap<K, V>

pub fn from_single(key: K, value: V) -> Self

Create a map with a single key-value pair.

impl<K: Ord, V> KeyDataMap<K, V>

pub fn insert(&mut self, key: K, value: V)

Insert a value at the given key.

pub fn get(&self, key: &K) -> Option<&V>

Get a value at the exact key.

impl<K, V> KeyDataMap<K, V>

where K: Ord + Copy + Into<f32>, V: Clone + Add<Output = V> + Mul<f32, Output = V> + Sub<Output = V>,

pub fn interpolate(&self, key: K) -> V

impl<K: Ord + Copy + Into<f32>, V> KeyDataMap<K, V>

pub fn sample_closest_at(&self, key: K) -> &V

pub fn sample_at(&self, key: K) -> Option<&V>

Sample value at exact key (no interpolation).

pub fn sample_at_or_before(&self, key: K) -> Option<&V>

Get the value at or before the given key.

pub fn sample_at_or_after(&self, key: K) -> Option<&V>

Get the value at or after the given key.

pub fn sample_surrounding<const N: usize>( &self, key: K, ) -> SmallVec<[(K, &V); N]>

Get surrounding samples for interpolation.

Returns up to N samples centered around the given key for use in interpolation algorithms.

pub fn closest_sample(&self, key: K) -> &V

👎Deprecated since 0.2.3: renamed to sample_closest_at

Deprecated alias for sample_closest_at.

Trait Implementations

impl<K, V> AsRef<BTreeMap<K, V>> for KeyDataMap<K, V>

Available on non-crate feature interpolation only.

fn as_ref(&self) -> &BTreeMap<K, V>

Converts this type into a shared reference of the (usually inferred) input type.

impl<K: Clone, V: Clone> Clone for KeyDataMap<K, V>

fn clone(&self) -> KeyDataMap<K, V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<K: Ord, V> DataTypeOps for KeyDataMap<K, V>

where V: DataTypeOps,

Available on crate feature builtin-types only.

fn data_type(&self) -> DataType

Returns the DataType variant for this value.

fn type_name(&self) -> &'static str

Returns a string name for this data type.

impl<K: Debug, V: Debug> Debug for KeyDataMap<K, V>

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

Formats the value using the given formatter.

impl From<KeyDataMap<Tick, Boolean>> for AnimatedData

fn from(v: TimeDataMap<Boolean>) -> AnimatedData

Converts to this type from the input type.

impl From<KeyDataMap<Tick, BooleanVec>> for AnimatedData

fn from(v: TimeDataMap<BooleanVec>) -> AnimatedData

Converts to this type from the input type.

impl From<KeyDataMap<Tick, Color>> for AnimatedData

fn from(v: TimeDataMap<Color>) -> AnimatedData

Converts to this type from the input type.

impl From<KeyDataMap<Tick, ColorCurve>> for AnimatedData

Available on crate feature curves only.

fn from(v: TimeDataMap<ColorCurve>) -> AnimatedData

Converts to this type from the input type.

impl From<KeyDataMap<Tick, ColorVec>> for AnimatedData

fn from(v: TimeDataMap<ColorVec>) -> AnimatedData

Converts to this type from the input type.

impl From<KeyDataMap<Tick, Integer>> for AnimatedData

fn from(v: TimeDataMap<Integer>) -> AnimatedData

Converts to this type from the input type.

impl From<KeyDataMap<Tick, IntegerVec>> for AnimatedData

fn from(v: TimeDataMap<IntegerVec>) -> AnimatedData

Converts to this type from the input type.

impl From<KeyDataMap<Tick, Matrix3>> for AnimatedData

Available on crate feature matrix3 only.

fn from(v: TimeDataMap<Matrix3>) -> AnimatedData

Converts to this type from the input type.

impl From<KeyDataMap<Tick, Matrix3Vec>> for AnimatedData

Available on crate features matrix3 and vec_variants only.

fn from(v: TimeDataMap<Matrix3Vec>) -> AnimatedData

Converts to this type from the input type.

impl From<KeyDataMap<Tick, Real>> for AnimatedData

fn from(v: TimeDataMap<Real>) -> AnimatedData

Converts to this type from the input type.

impl From<KeyDataMap<Tick, RealCurve>> for AnimatedData

Available on crate feature curves only.

fn from(v: TimeDataMap<RealCurve>) -> AnimatedData

Converts to this type from the input type.

impl From<KeyDataMap<Tick, RealVec>> for AnimatedData

fn from(v: TimeDataMap<RealVec>) -> AnimatedData

Converts to this type from the input type.

impl From<KeyDataMap<Tick, String>> for AnimatedData

fn from(v: TimeDataMap<String>) -> AnimatedData

Converts to this type from the input type.

impl From<KeyDataMap<Tick, StringVec>> for AnimatedData

fn from(v: TimeDataMap<StringVec>) -> AnimatedData

Converts to this type from the input type.

impl From<KeyDataMap<Tick, Vector2>> for AnimatedData

Available on crate feature vector2 only.

fn from(v: TimeDataMap<Vector2>) -> AnimatedData

Converts to this type from the input type.

impl From<KeyDataMap<Tick, Vector2Vec>> for AnimatedData

Available on crate features vector2 and vec_variants only.

fn from(v: TimeDataMap<Vector2Vec>) -> AnimatedData

Converts to this type from the input type.

impl<K: Ord, V> From<NonEmpty<BTreeMap<K, V>>> for KeyDataMap<K, V>

Available on non-crate feature interpolation only.

fn from(values: BTreeMap1<K, V>) -> Self

Converts to this type from the input type.

impl<K: Ord, V, U> FromIterator<(K, U)> for KeyDataMap<K, V>

where U: Into<V>,

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = (K, U)>,

Creates a value from an iterator.

impl<K: Hash, V: Hash> Hash for KeyDataMap<K, V>

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<K: PartialEq, V: PartialEq> PartialEq for KeyDataMap<K, V>

fn eq(&self, other: &KeyDataMap<K, V>) -> 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<V> TimeDataMapControl<V> for KeyDataMap<Time, V>

fn len(&self) -> usize

Returns the number of time samples.

fn is_empty(&self) -> bool

Returns true if there are no time samples.

fn is_animated(&self) -> bool

Returns true if there is more than one time sample.

impl<K: Ord, V> TryFrom<BTreeMap<K, V>> for KeyDataMap<K, V>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(values: BTreeMap<K, V>) -> Result<Self>

Performs the conversion.

impl TryInto<KeyDataMap<Tick, Boolean>> for AnimatedData

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<Boolean>, <Self as TryInto<TimeDataMap<Boolean>>>::Error>

Performs the conversion.

impl TryInto<KeyDataMap<Tick, BooleanVec>> for AnimatedData

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<BooleanVec>, <Self as TryInto<TimeDataMap<BooleanVec>>>::Error>

Performs the conversion.

impl TryInto<KeyDataMap<Tick, Color>> for AnimatedData

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<Color>, <Self as TryInto<TimeDataMap<Color>>>::Error>

Performs the conversion.

impl TryInto<KeyDataMap<Tick, ColorCurve>> for AnimatedData

Available on crate feature curves only.

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<ColorCurve>, <Self as TryInto<TimeDataMap<ColorCurve>>>::Error>

Performs the conversion.

impl TryInto<KeyDataMap<Tick, ColorVec>> for AnimatedData

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<ColorVec>, <Self as TryInto<TimeDataMap<ColorVec>>>::Error>

Performs the conversion.

impl TryInto<KeyDataMap<Tick, Integer>> for AnimatedData

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<Integer>, <Self as TryInto<TimeDataMap<Integer>>>::Error>

Performs the conversion.

impl TryInto<KeyDataMap<Tick, IntegerVec>> for AnimatedData

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<IntegerVec>, <Self as TryInto<TimeDataMap<IntegerVec>>>::Error>

Performs the conversion.

impl TryInto<KeyDataMap<Tick, Matrix3>> for AnimatedData

Available on crate feature matrix3 only.

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<Matrix3>, <Self as TryInto<TimeDataMap<Matrix3>>>::Error>

Performs the conversion.

impl TryInto<KeyDataMap<Tick, Matrix3Vec>> for AnimatedData

Available on crate features matrix3 and vec_variants only.

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<Matrix3Vec>, <Self as TryInto<TimeDataMap<Matrix3Vec>>>::Error>

Performs the conversion.

impl TryInto<KeyDataMap<Tick, Real>> for AnimatedData

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<Real>, <Self as TryInto<TimeDataMap<Real>>>::Error>

Performs the conversion.

impl TryInto<KeyDataMap<Tick, RealCurve>> for AnimatedData

Available on crate feature curves only.

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<RealCurve>, <Self as TryInto<TimeDataMap<RealCurve>>>::Error>

Performs the conversion.

impl TryInto<KeyDataMap<Tick, RealVec>> for AnimatedData

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<RealVec>, <Self as TryInto<TimeDataMap<RealVec>>>::Error>

Performs the conversion.

impl TryInto<KeyDataMap<Tick, String>> for AnimatedData

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<String>, <Self as TryInto<TimeDataMap<String>>>::Error>

Performs the conversion.

impl TryInto<KeyDataMap<Tick, StringVec>> for AnimatedData

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<StringVec>, <Self as TryInto<TimeDataMap<StringVec>>>::Error>

Performs the conversion.

impl TryInto<KeyDataMap<Tick, Vector2>> for AnimatedData

Available on crate feature vector2 only.

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<Vector2>, <Self as TryInto<TimeDataMap<Vector2>>>::Error>

Performs the conversion.

impl TryInto<KeyDataMap<Tick, Vector2Vec>> for AnimatedData

Available on crate features vector2 and vec_variants only.

type Error = &'static str

The type returned in the event of a conversion error.

fn try_into( self, ) -> Result<TimeDataMap<Vector2Vec>, <Self as TryInto<TimeDataMap<Vector2Vec>>>::Error>

Performs the conversion.

impl<K: Eq, V: Eq> Eq for KeyDataMap<K, V>

impl<K, V> StructuralPartialEq for KeyDataMap<K, V>