Struct skeletal_model::bone::BoneMap

pub struct BoneMap<T>([T; 16]);

Provides a map of BoneKind -> T. Every possible BoneKind must have a corresponding value.

This is more efficient than a HashMap, because it is done without allocation inline, and the BoneKinds don’t need to be hashed.

Example

let mut m = BoneMap::default();
for b in BoneKind::iter() {
    m[b] = format!("this is a {b:?}");
}

assert_eq!(m[BoneKind::Chest], format!("this is a {:?}", BoneKind::Chest))

Tuple Fields

0: [T; 16]

Implementations

impl<T> BoneMap<T>

pub fn new(map: [T; 16]) -> Self

pub fn iter(&self) -> Iter<'_, T>

Gets an iterator over the (key, value) pairs of the BoneMap.

Iteration is guaranteed to start at BoneKind::root() but beyond that, iteration order is not guaranteed. However, iteration is exhaustive over the various kinds of bones.

pub fn iter_mut(&mut self) -> IterMut<'_, T>

Gets a mutable iterator over the (key, value) pairs of the BoneMap.

See also: Self::iter()

pub fn map<U>(self, f: impl FnMut(BoneKind, T) -> U) -> BoneMap<U>

Applies a function to each element of the BoneMap, mapping it from T to U.

Trait Implementations

impl<T: Clone> Clone for BoneMap<T>

fn clone(&self) -> BoneMap<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for BoneMap<T>

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

Formats the value using the given formatter.

impl<T: Default> Default for BoneMap<T>

fn default() -> BoneMap<T>

Returns the “default value” for a type.

impl<T> From<[T; 16]> for BoneMap<T>

fn from(original: [T; 16]) -> BoneMap<T>

Converts to this type from the input type.

impl<T> Index<BoneKind> for BoneMap<T>

type Output = T

The returned type after indexing.

fn index(&self, index: BoneKind) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<T> IndexMut<BoneKind> for BoneMap<T>

fn index_mut(&mut self, index: BoneKind) -> &mut Self::Output

Performs the mutable indexing (container[index]) operation.

impl<'a, T> IntoIterator for &'a BoneMap<T>

type Item = (BoneKind, &'a T)

The type of the elements being iterated over.

type IntoIter = Map<Enumerate<Iter<'a, T>>, fn((usize, &'a T)) -> (BoneKind, &'a T)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut BoneMap<T>

type Item = (BoneKind, &'a mut T)

The type of the elements being iterated over.

type IntoIter = Map<Enumerate<IterMut<'a, T>>, fn((usize, &'a mut T)) -> (BoneKind, &'a mut T)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T> IntoIterator for BoneMap<T>

type Item = (BoneKind, T)

The type of the elements being iterated over.

type IntoIter = Map<Enumerate<IntoIter<T, { BoneKind::NUM_TYPES }>>, fn((usize, T)) -> (BoneKind, T)>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T: PartialEq> PartialEq<BoneMap<T>> for BoneMap<T>

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> TryFrom<HashMap<BoneKind, T, RandomState>> for BoneMap<T>

type Error = IncompleteArrayError

The type returned in the event of a conversion error.

fn try_from(other: HashMap<BoneKind, T>) -> Result<Self, Self::Error>

Performs the conversion.

impl<T> TryFromIterator<(BoneKind, T)> for BoneMap<T>

type Error = IncompleteArrayError

The type returned in the event of a conversion error.

fn try_from_iter<I>(iter: I) -> Result<Self, Self::Error>where
    I: IntoIterator<Item = (BoneKind, T)>,

Attempts to perform the conversion.

impl<T: Copy> Copy for BoneMap<T>

impl<T: Eq> Eq for BoneMap<T>

impl<T> StructuralEq for BoneMap<T>

impl<T> StructuralPartialEq for BoneMap<T>