cstr 0.1.7

Macro for building static CStr reference
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39

# cstr

[![Build Status](https://travis-ci.org/upsuper/cstr.svg?branch=master)](https://travis-ci.org/upsuper/cstr)
[![Docs](https://docs.rs/cstr/badge.svg)](https://docs.rs/cstr)

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`.

Note that it currently cannot be used to initialize constants due
to restriction of Rust.

Also, it currently only supports a UTF-8 string as input because
Rust's tokenizer only accepts that without the `b` prefix. This
may be expanded in the future if necessary.

# Example

```rust
#[macro_use] extern crate cstr;
use std::ffi::CStr;

fn main() {
    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());
}
```

# Note for 2018 edition

On Rust 2018 edition, you can not simply use `cstr::cstr!(...)` or
`use cstr::cstr;` due to limitation of procedural-masquerade,
the crate we use to build this macro.

You need to stick with 2015 edition's `#[macro_use]` or import
everything from this crate via `use cstr::*;`.