cubing_core 0.15.2

Features from `cubing.js` in Rust.
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
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

// TODO: Turn these into proc macros to validate at compile time?

/// Load a `KPuzzle` from a JSON file in your source code. The file will only be
/// loaded on the first call, and all subsequent calls will use the cached
/// value. Call `.to_owned()` on the result if you need an owned value.
///
///  Example:
///
/// ```
/// # pub mod cubing {
/// #   pub mod kpuzzle {
/// #     pub use cubing_core::kpuzzle::KPuzzle;
/// #     pub use cubing_core::kpuzzle_from_json_file;
/// #   }
/// # }
/// use cubing::kpuzzle::KPuzzle;
/// use cubing::kpuzzle::kpuzzle_from_json_file;
///
/// kpuzzle_from_json_file!(pub(crate), example, "./example.kpuzzle.json");
/// let kpuzzle: &KPuzzle = example_kpuzzle();
/// ```
#[macro_export]
macro_rules! kpuzzle_from_json_file {
    ($visibility:vis, $kpuzzle_name: ident, $file:expr) => {
      $crate::kpuzzle::_reexported::_paste::paste! {
          #[allow(non_upper_case_globals)]
          static [<$kpuzzle_name _kpuzzle_cell>]: std::sync::OnceLock<$crate::kpuzzle::KPuzzle> = std::sync::OnceLock::new();
          $visibility fn [<$kpuzzle_name _kpuzzle>]() -> &'static $crate::kpuzzle::KPuzzle {
                [<$kpuzzle_name _kpuzzle_cell>].get_or_init(|| {
                    let def: $crate::kpuzzle::KPuzzleDefinition = serde_json::from_slice(include_bytes!($file)).unwrap();
                    let kpuzzle: $crate::kpuzzle::KPuzzle = def.try_into().unwrap();
                    kpuzzle
                })
            }
        }
    };
}

/// Load a `KPattern` from a JSON file in your source code. The file will only be
/// loaded on the first call, and all subsequent calls will use the cached
/// value. Call `.to_owned()` on the result if you need an owned value.
///
///  Example:
///
/// ```
/// # pub mod cubing {
/// #   pub mod kpuzzle {
/// #     pub use cubing_core::kpuzzle::KPattern;
/// #     pub use cubing_core::{kpattern_from_json_file, kpuzzle_from_json_file};
/// #   }
/// # }
/// use cubing::kpuzzle::KPattern;
/// use cubing::kpuzzle::{kpattern_from_json_file, kpuzzle_from_json_file};
///
/// kpuzzle_from_json_file!(pub(crate), example, "./example.kpuzzle.json");
///
/// kpattern_from_json_file!(pub(crate), example, "./example.kpattern.json", example_kpuzzle());
/// let kpattern: &KPattern = example_kpattern();
/// ```
#[macro_export]
macro_rules! kpattern_from_json_file {
    ($visibility:vis, $kpattern_name: ident, $file:expr, $kpuzzle: expr) => {
      $crate::kpuzzle::_reexported::_paste::paste! {
          #[allow(non_upper_case_globals)]
          static [<$kpattern_name _kpattern_cell>]: std::sync::OnceLock<$crate::kpuzzle::KPattern> = std::sync::OnceLock::new();
          $visibility fn [<$kpattern_name _kpattern>]() -> &'static $crate::kpuzzle::KPattern {
            [<$kpattern_name _kpattern_cell>]
                  .get_or_init(|| {
                    $crate::kpuzzle::KPattern::try_from_json(
                          $kpuzzle,
                          include_bytes!($file),
                      )
                      .unwrap()
                  })

                }
          }
    };
}

/// Load a `KTransformation` from a JSON file in your source code. The file will only be
/// loaded on the first call, and all subsequent calls will use the cached
/// value. Call `.to_owned()` on the result if you need an owned value.
///
///  Example:
///
/// ```
/// # pub mod cubing {
/// #   pub mod kpuzzle {
/// #     pub use cubing_core::kpuzzle::KTransformation;
/// #     pub use cubing_core::{kpuzzle_from_json_file, ktransformation_from_json_file};
/// #   }
/// # }
/// use cubing::kpuzzle::KTransformation;
/// use cubing::kpuzzle::{kpuzzle_from_json_file, ktransformation_from_json_file};
///
/// kpuzzle_from_json_file!(pub(crate), example, "./example.kpuzzle.json");
///
/// ktransformation_from_json_file!(pub(crate), example, "./example.ktransformation.json", example_kpuzzle());
/// let ktransformation: &KTransformation = example_ktransformation();
/// ```
#[macro_export]
macro_rules! ktransformation_from_json_file {
    ($visibility:vis, $ktransformation_name: ident, $file:expr, $kpuzzle: expr) => {
      $crate::kpuzzle::_reexported::_paste::paste! {
          #[allow(non_upper_case_globals)]
          static [<$ktransformation_name _ktransformation_cell>]: std::sync::OnceLock<$crate::kpuzzle::KTransformation> = std::sync::OnceLock::new();
          $visibility fn [<$ktransformation_name _ktransformation>]() -> &'static $crate::kpuzzle::KTransformation {
            [<$ktransformation_name _ktransformation_cell>]
                  .get_or_init(|| {
                    $crate::kpuzzle::KTransformation::try_from_json(
                          $kpuzzle,
                          include_bytes!($file),
                      )
                      .unwrap()
                  })

                }
          }
    };
}