Struct Parts 

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

Generic collection for Parts

Serialize/Deserialize

Serialize and Deserialize are implemented for this type.

Box (no Copy)

The inner array of this type is wrapped in a Box. Fields within a Part already use a Box so we are forced to wrap the data in a Box here.

Example: Extending in your own code with custom inner types

use ot_tools_io::types::Parts;
use std::path::PathBuf;

use ot_tools_io::Defaults;
use ot_tools_io_derive::{ArrayDefaults, BoxedArrayDefaults};
use std::array::from_fn;

#[derive(Debug, PartialEq, Default, ArrayDefaults, BoxedArrayDefaults)]
pub struct LongPartName(String);

let mut my_part_names = Parts::<LongPartName>::default();
let first = my_part_names.first_mut().ok_or(())?;
*first = LongPartName(String::from("My awesome part name that is too long on the octatrack"));

// first one changed
assert_eq!(
    my_part_names[0],
    LongPartName(
        String::from("My awesome part name that is too long on the octatrack")
    )
);
// rest are default
assert_eq!(my_part_names[1], LongPartName::default());


// correct length
assert_eq!(my_part_names.len(), 4);

Implementations

impl<T> Parts<T>

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

pub fn new_boxed(value: Box<[T; 4]>) -> Self

impl<T> Parts<T>

pub fn id_ref(&self, id: &PartId) -> &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: &PartId) -> &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> Parts<T>

pub fn id(self, id: &PartId) -> 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> Parts<T>

pub fn unbox(self) -> [T; 4]

Returns an owned [T; 16] by “un-boxing” (dereferencing) the data

pub fn unbox_ref(&self) -> &[T; 4]

Returns a referenced [T; 16] by “un-boxing” (dereferencing) the data

pub fn unbox_mut(&mut self) -> &mut [T; 4]

Returns a mutably referenced [T; 16] by “un-boxing” (dereferencing) the data

Trait Implementations

impl<T> AsMut<Parts<T>> for Parts<T>

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

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

impl<T> AsRef<Parts<T>> for Parts<T>

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

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

impl<T: Clone> Clone for Parts<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Parts<T>

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

Formats the value using the given formatter.

impl<T: Defaults<Box<[T; 4]>> + Default> Default for Parts<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Deref for Parts<T>

type Target = [T; 4]

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Parts<T>

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

Mutably dereferences the value.

impl<'de> Deserialize<'de> for Parts<Part>

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 Parts<T>

impl HasHeaderField for Parts<Part>

fn check_header(&self) -> Result<bool, OtToolsIoError>

Method to verify if header(s) are valid in some data. See this thread.

impl<T: Hash> Hash for Parts<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: Ord> Ord for Parts<T>

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

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

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialOrd> PartialOrd for Parts<T>

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

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 Parts<T>