2 stable releases
1.1.0 | Feb 16, 2023 |
---|---|
1.0.0 | Feb 16, 2023 |
#84 in #read-file
3,616 downloads per month
Used in 3 crates
(via include-lines)
3KB
include-lines
Rust macros for reading in all lines from a file at compile time. This can be very useful for loading static data.
Examples
For the examples, there is a file file.txt
in the same directory as the project's Cargo.toml file:
these
are
file
lines
Read in a file and store it an an array of type [&'static str]
use include_lines::include_lines;
let lines = include_lines!("file.txt");
For the example file, this expands to:
let lines = [
"these",
"are",
"file",
"lines",
];
Read in a file and store it an an array of type [String]
use include_lines::include_lines_s;
let lines = include_lines_s!("file.txt");
For the example file, this expands to:
let lines = [
String::from("these"),
String::from("are"),
String::from("file"),
String::from("lines"),
];
Get the number of lines in a file at compile time as type usize
use include_lines::count_lines;
let num_lines = count_lines!("file.txt");
For the example file, this expands to:
let num_lines = 4usize;
Create a static array from a file at compile time
You can use the static_include_lines!
and static_include_lines_s!
macros to initialize static text arrays at compile time:
use include_lines::{static_include_lines};
static_include_lines!(LINES, "file.txt");
For the example file, this expands to:
static LINES: [&str; 4] = [
"these",
"are",
"file",
"lines",
];
Dependencies
~1.5MB
~35K SLoC