Struct Scenes 

pub struct Scenes<T>(/* private fields */);

Generic collection for scene data. Used in the scenes and scene_xlvs fields on Part.

Copy (no Box)

This generic collection helper does not use Box and can be Copy.

Example: Using in your own code with custom inner types

use ot_tools_io::types::Scenes;
use ot_tools_io::Defaults;
use ot_tools_io_derive::ArrayDefaults;
use std::array::from_fn;

#[derive(Debug, PartialEq, Default, ArrayDefaults)]
pub struct SomeNumber(u8);

fn main() -> Result<(), ()> {
    let mut my_scenes = Scenes::<SomeNumber>::default();
    let first = my_scenes.first_mut().ok_or(())?;
    *first = SomeNumber(100);

    // first one changed
    assert_eq!(my_scenes[0], SomeNumber(100));
    // rest are default
    assert_eq!(my_scenes[1], SomeNumber(0));

    // correct length
    assert_eq!(my_scenes.len(), 16);

    Ok(())
}

Implementations

impl<T> Scenes<T>

pub fn id_ref(&self, id: &SceneId) -> &T

Returns a reference to an element of the array data

Panic-free

This method is panic-free as the id type is guaranteed to never exceed the max index of the underlying array.

pub fn id_mut(&mut self, id: &SceneId) -> &mut T

Returns a mutable reference to an element the array data

Panic-free

This method is panic-free as the id type is guaranteed to never exceed the max index of the underlying array.

impl<T: Copy> Scenes<T>

pub fn id(self, id: &SceneId) -> T

Returns an owned element of the array data

Panic-free

This method is panic-free as the id type is guaranteed to never exceed the max index of the underlying array.

impl<T> Scenes<T>

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

Trait Implementations

impl<T> AsMut<Scenes<T>> for Scenes<T>

fn as_mut(&mut self) -> &mut Scenes<T>

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

impl<T> AsRef<Scenes<T>> for Scenes<T>

fn as_ref(&self) -> &Scenes<T>

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

impl<T: Clone> Clone for Scenes<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Copy> Copy for Scenes<T>

impl<T: Debug> Debug for Scenes<T>

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

Formats the value using the given formatter.

impl<T: Defaults<[T; 16]> + Default> Default for Scenes<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Deref for Scenes<T>

type Target = [T; 16]

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Scenes<T>

fn deref_mut(&mut self) -> &mut Self::Target

Mutably dereferences the value.

impl<'de, T: Deserialize<'de>> Deserialize<'de> for Scenes<T>

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<T: Eq> Eq for Scenes<T>

impl<T: Hash> Hash for Scenes<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<T, I> Index<I> for Scenes<T>

where [T]: Index<I>,

type Output = <[T] as Index<I>>::Output

The returned type after indexing.

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

Performs the indexing (container[index]) operation.

impl<T, I> IndexMut<I> for Scenes<T>

where [T]: IndexMut<I>,

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

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

impl<T: Ord> Ord for Scenes<T>

fn cmp(&self, other: &Scenes<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<T: PartialEq> PartialEq for Scenes<T>

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

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialOrd> PartialOrd for Scenes<T>

fn partial_cmp(&self, other: &Scenes<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<T: Serialize> Serialize for Scenes<T>

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl<T: PartialEq> StructuralPartialEq for Scenes<T>