grid2d 2.0.0

Two dimensional grid of runtime-defined, but unchangable size
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64

use alloc::vec::Vec;
use core::error::Error;
use core::fmt::{Debug, Display, Formatter};

/// Errors that can occur when building a grid.
#[derive(Clone, Debug, Eq, PartialEq)]
pub enum BuildError<T> {
    /// Neither `width` nor `height` have been set.
    NeitherWidthNotHeightSet(Vec<T>),
    /// The specified width is larger than the amount of items.
    TooWide(Vec<T>),
    /// The specified height is larger than the amount if items.
    TooTall(Vec<T>),
    /// The desired grid size (`width` * `height`) does not match the amount of items.
    SizeDoesNotMatch(Vec<T>),
    /// The amount of items is not a multiple of the specified `width`.
    SizeNotMultipleOfWidth(Vec<T>),
    /// The amount of items is not a multiple of the specified `height`.
    SizeNotMultipleOfHeight(Vec<T>),
}

impl<T> BuildError<T> {
    /// Return the items that were stored in the [`GridBuilder`](crate::GridBuilder).
    #[must_use]
    pub fn into_items(self) -> Vec<T> {
        match self {
            Self::NeitherWidthNotHeightSet(items)
            | Self::TooWide(items)
            | Self::TooTall(items)
            | Self::SizeDoesNotMatch(items)
            | Self::SizeNotMultipleOfWidth(items)
            | Self::SizeNotMultipleOfHeight(items) => items,
        }
    }
}

impl<T> Display for BuildError<T> {
    fn fmt(&self, f: &mut Formatter<'_>) -> core::fmt::Result {
        match self {
            Self::NeitherWidthNotHeightSet(_) => {
                write!(f, "neither a width nor a height was set")
            }
            Self::TooWide(_) => write!(f, "the specified width exceeds the amount of items"),
            Self::TooTall(_) => write!(f, "the specified height exceeds the amount of items"),
            Self::SizeDoesNotMatch(_) => {
                write!(f, "the desired size does not match the amount of items")
            }
            Self::SizeNotMultipleOfWidth(_) => {
                write!(
                    f,
                    "the desired width is not a multiple of the amount of items"
                )
            }
            Self::SizeNotMultipleOfHeight(_) => {
                write!(
                    f,
                    "the desired height is not a multiple of the amount of items"
                )
            }
        }
    }
}

impl<T> Error for BuildError<T> where T: Debug {}