#options #proc-macro #include #version

nightly macro no-std include_optional

Option-returning versions of include_X macros

2 stable releases

1.0.1 Aug 15, 2021
1.0.0 Aug 14, 2021

#1285 in Procedural macros

31 downloads per month

MIT/Apache

11KB
138 lines

include_optional


Note: This currently only works on nightly Rust. This crate depends on proc_macro::SourceFile::path(), which is not yet stabilized (additionally, there is a dependency on the unstable function std::path::Path::try_exists, however, this dependency could probably be removed without too much hassle).

If you are able to somehow avoid this dependency, pull requests are welcome!


This crate allows you to optionally include a file as a Option. This crate supports the complete include_X! macro family (include_bytes!, include! and include_str!).

Installation

Add this to your Cargo.toml:

[dependencies]
include_optional = "1.0"

Example

This includes some metadata from a file, falling back to default metadata if the file is missing:

use include_optional::include_str_optional;

fn main() {
    let metadata:  &'static str = include_str_optional!("./metadata_files/file_exists.txt" ).unwrap_or("default metadata string");
    //...
}

Dependencies

~1.5MB
~34K SLoC