add lazy_static_include_array

magiclen · magiclen · commit a32b699bffda · 2018-09-09T23:39:29.000+08:00
diff --git a/Cargo.toml b/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "lazy-static-include"
-version = "1.0.0"
+version = "1.1.0"
 authors = ["Magic Len <len@magiclen.org>"]
 repository = "https://github.com/magiclen/lazy-static-include"
 homepage = "https://magiclen.org/lazy-static-include"
diff --git a/README.md b/README.md
@@ -41,7 +41,7 @@ assert_eq!("This is just a test text.".as_bytes(), TEST[0]);
 assert_eq!(TEST[1], "Some text...".as_bytes());
 ```
 
-You should notice that the struct created from `include_bytes` and `include_str` macros isn't equal to `&'static [u8]` or `&'static str`.
+You should notice that the struct created from `lazy_static_include_bytes` and `lazy_static_include_str` macros isn't equal to `&'static [u8]` or `&'static str`.
 If you want to get an exact `&'static [u8]` or `&'static str` reference, you need to **dereference the struct**.
 
 ```rust
@@ -65,6 +65,54 @@ lazy_static_include_str!(TEST, "data/test.txt", "data/test-2.txt");
 let v: &Vec<&'static str> = &*TEST;
 ```
 
+## Include Array
+
+There is a special macro `lazy_static_include_array` which can include arrays from files.
+The array is fixed sized and can be one of these following types: `bool`, `char`, `u8`, `u16`, `u32`, `u64`, `u128`, `i8`, `i16`, `i32`, `i64`, `i128`, `f32`, `f64`, `&'static str`.
+
+Also, the `lazy_static_include_array` macro includes data from files into the compiled executable binary file **only** when you are using the **release** profile.
+Be careful when you distribute your program.
+
+```rust
+#[macro_use] extern crate lazy_static_include;
+#[macro_use] extern crate lazy_static;
+
+lazy_static_include_array!(TEST: [u64; 5], "data/u64_array.txt");
+assert_eq!(123, TEST[0]);
+assert_eq!(456, TEST[1]);
+assert_eq!(789, TEST[2]);
+assert_eq!(1000, TEST[3]);
+assert_eq!(500000000000u64, TEST[4]);
+```
+
+```rust
+#[macro_use] extern crate lazy_static_include;
+#[macro_use] extern crate lazy_static;
+
+lazy_static_include_array!(TEST: [i32; 5], "data/i32_array.txt", "data/i32_array-2.txt");
+assert_eq!(123, TEST[0][0]);
+assert_eq!(-456, TEST[0][1]);
+assert_eq!(789, TEST[0][2]);
+assert_eq!(1000, TEST[0][3]);
+assert_eq!(5000, TEST[0][4]);
+
+assert_eq!(-1, TEST[1][0]);
+assert_eq!(-2, TEST[1][1]);
+assert_eq!(-3, TEST[1][2]);
+assert_eq!(-4, TEST[1][3]);
+assert_eq!(-5, TEST[1][4]);
+```
+```rust
+#[macro_use] extern crate lazy_static_include;
+#[macro_use] extern crate lazy_static;
+
+lazy_static_include_array!(pub TEST: [&'static str; 3], "data/string_array.txt");
+
+assert_eq!("Hi", TEST[0]);
+assert_eq!("Hello", TEST[1]);
+assert_eq!("哈囉", TEST[2]);
+```
+
 ## Crates.io
 
 https://crates.io/crates/lazy-static-include
diff --git a/data/bool_array.txt b/data/bool_array.txt
@@ -0,0 +1 @@
+[false, true, false]
diff --git a/data/char_array.txt b/data/char_array.txt
@@ -0,0 +1 @@
+['a', 'b', 'c']
diff --git a/data/f32_array.txt b/data/f32_array.txt
@@ -0,0 +1 @@
+[123.0, -456.0, 789.5, 1_000.123f32, 5000f32]
diff --git a/data/f64_array.txt b/data/f64_array.txt
@@ -0,0 +1 @@
+[123.0, -456.0, 789.5, 1_000.123f64, 5000.456f64]
diff --git a/data/i128_array.txt b/data/i128_array.txt
@@ -0,0 +1 @@
+[123, -456, 789, 1_000, 500000000000000000000000i128]
diff --git a/data/i16_array.txt b/data/i16_array.txt
@@ -0,0 +1 @@
+[123, -456, 789, 1_000, 5000i16]
diff --git a/data/i32_array-2.txt b/data/i32_array-2.txt
@@ -0,0 +1 @@
+[-1, -2, -3, -4, -5]
diff --git a/data/i32_array.txt b/data/i32_array.txt
@@ -0,0 +1 @@
+[123, -456, 789, 1_000, 5000i32]
diff --git a/data/i64_array.txt b/data/i64_array.txt
@@ -0,0 +1 @@
+[123, -456, 789, 1_000, 500000000000i64]
diff --git a/data/i8_array.txt b/data/i8_array.txt
@@ -0,0 +1 @@
+[12, -34, 56, 7_8, 90i8]
diff --git a/data/string_array-2.txt b/data/string_array-2.txt
@@ -0,0 +1 @@
+["Hello world!", "Rust", "你好"]
diff --git a/data/string_array.txt b/data/string_array.txt
@@ -0,0 +1 @@
+["Hi", "Hello", "哈囉"]
diff --git a/data/u128_array.txt b/data/u128_array.txt
@@ -0,0 +1 @@
+[123, 456, 789, 1_000, 500000000000000000000000u128]
diff --git a/data/u16_array.txt b/data/u16_array.txt
@@ -0,0 +1 @@
+[123, 456, 789, 1_000, 5000u16]
diff --git a/data/u32_array.txt b/data/u32_array.txt
@@ -0,0 +1 @@
+[123, 456, 789, 1_000, 5000u32]
diff --git a/data/u64_array.txt b/data/u64_array.txt
@@ -0,0 +1 @@
+[123, 456, 789, 1_000, 500000000000u64]
diff --git a/data/u8_array.txt b/data/u8_array.txt
@@ -0,0 +1 @@
+[12, 34, 56, 7_8, 90u8]
diff --git a/src/lib.rs b/src/lib.rs
diff --git a/tests/macro.rs b/tests/macro.rs

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+[123.0, -456.0, 789.5, 1_000.123f32, 5000f32]`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+[123.0, -456.0, 789.5, 1_000.123f64, 5000.456f64]`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+[123, -456, 789, 1_000, 500000000000000000000000i128]`