summaryrefslogtreecommitdiffstats
path: root/third_party/rust/cstr/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'third_party/rust/cstr/README.md')
-rw-r--r--third_party/rust/cstr/README.md30
1 files changed, 30 insertions, 0 deletions
diff --git a/third_party/rust/cstr/README.md b/third_party/rust/cstr/README.md
new file mode 100644
index 0000000000..7ee3ba2474
--- /dev/null
+++ b/third_party/rust/cstr/README.md
@@ -0,0 +1,30 @@
+# cstr
+
+[![CI](https://github.com/upsuper/cstr/workflows/CI/badge.svg)](https://github.com/upsuper/cstr/actions)
+[![Crates.io](https://img.shields.io/crates/v/cstr.svg)](https://crates.io/crates/cstr)
+[![Docs](https://docs.rs/cstr/badge.svg)](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.64 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 -->