Struct Arrangements 

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

Generic collection for ArrangementFiles.

Serialize/Deserialize

Neither Serialize nor Deserialize are implemented for this type.

Box (no Copy)

The inner array of this type is wrapped in a Box. – we cannot fit all ArrangementFiles on the stack. Unfortunately this means the type does not implement Copy.

Example: Extending in your own code with custom inner types

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

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 BackupPath(PathBuf);

let mut my_backups = Arrangements::<BackupPath>::default();
let my_new_backup = BackupPath(PathBuf::from("some_path"));
let first = my_backups.first_mut().ok_or(())?;
*first = my_new_backup;

// first one changed
assert_eq!(my_backups[0], BackupPath(PathBuf::from("some_path")));
// rest are default
assert_eq!(my_backups[1], BackupPath::default());

// correct length
assert_eq!(my_backups.len(), 8);

Implementations

impl<T> Arrangements<T>

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

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

impl<T> Arrangements<T>

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

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

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

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

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

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

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

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

impl Arrangements<ArrangementFile>

Concrete implementation for ArrangementFile adds two methods for reading and writing a batch of files.

pub fn from_data_files<P>( dirpath: P, state: &SavedState, ) -> Result<Self, OtToolsIoError>

where PathBuf: From<P>,

Reads a collection of ArrangementFiles from a directory.

pub fn to_data_files<P>( &self, dirpath: P, state: &SavedState, skip_unchanged: bool, ) -> Result<(), OtToolsIoError>

where PathBuf: From<P>,

Writes a collection of ArrangementFiles to a directory.

Will skip writing a particular ArrangementFile if the skip_unchanged argument is true and the current ArrangementFile matches the data in the existing file on the file system.

Trait Implementations

impl<T> AsMut<Arrangements<T>> for Arrangements<T>

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

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

impl<T> AsRef<Arrangements<T>> for Arrangements<T>

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

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

impl<T: Clone> Clone for Arrangements<T>

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

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<T: Debug> Debug for Arrangements<T>

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

Formats the value using the given formatter.

impl<T: Defaults<Box<[T; 8]>> + Default> Default for Arrangements<T>

fn default() -> Self

Returns the “default value” for a type.

impl<T> Deref for Arrangements<T>

type Target = [T; 8]

The resulting type after dereferencing.

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

Dereferences the value.

impl<T> DerefMut for Arrangements<T>

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

Mutably dereferences the value.

impl<T: Eq> Eq for Arrangements<T>

impl HasHeaderField for Arrangements<ArrangementFile>

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

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

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

Equality operator ==.

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

Inequality operator !=.

impl<T: PartialOrd> PartialOrd for Arrangements<T>

fn partial_cmp(&self, other: &Arrangements<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: PartialEq> StructuralPartialEq for Arrangements<T>