diff options
Diffstat (limited to 'vendor/cstr/README.md')
| -rw-r--r-- | vendor/cstr/README.md | 30 |
1 files changed, 30 insertions, 0 deletions
diff --git a/vendor/cstr/README.md b/vendor/cstr/README.md new file mode 100644 index 000000000..e8950e7d1 --- /dev/null +++ b/vendor/cstr/README.md @@ -0,0 +1,30 @@ +# cstr + +[](https://github.com/upsuper/cstr/actions) +[](https://crates.io/crates/cstr) +[](https://docs.rs/cstr) + +<!-- cargo-sync-readme start --> + +A macro for getting `&'static CStr` from literal or identifier. + +This macro checks whether the given literal is valid for `CStr` +at compile time, and returns a static reference of `CStr`. + +This macro can be used to to initialize constants on Rust 1.46 and above. + +## Example + +```rust +use cstr::cstr; +use std::ffi::CStr; + +let test = cstr!(b"hello\xff"); +assert_eq!(test, CStr::from_bytes_with_nul(b"hello\xff\0").unwrap()); +let test = cstr!("hello"); +assert_eq!(test, CStr::from_bytes_with_nul(b"hello\0").unwrap()); +let test = cstr!(hello); +assert_eq!(test, CStr::from_bytes_with_nul(b"hello\0").unwrap()); +``` + +<!-- cargo-sync-readme end --> |