diff options
| author | Colin Walters <walters@verbum.org> | 2018-09-17 21:10:36 -0400 |
|---|---|---|
| committer | Colin Walters <walters@verbum.org> | 2018-09-17 21:10:36 -0400 |
| commit | 993d02283ec9802ad413069dcdbbf9ef464b636e (patch) | |
| tree | 0f4370bd417a87c03f592766163d7aeb48343e21 /src | |
| parent | 186fe091434b4c20c160b8098a56bb6a841bf6b1 (diff) | |
| download | rust-993d02283ec9802ad413069dcdbbf9ef464b636e.tar.gz rust-993d02283ec9802ad413069dcdbbf9ef464b636e.zip | |
OsStr: Document that it's not NUL terminated
I somehow got confused into thinking this was the case, but it's definitely not. Let's help the common case of people who have an `OsStr` and need to call e.g. Unix APIs.
Diffstat (limited to 'src')
| -rw-r--r-- | src/libstd/ffi/os_str.rs | 5 |
1 files changed, 4 insertions, 1 deletions
diff --git a/src/libstd/ffi/os_str.rs b/src/libstd/ffi/os_str.rs index 237af2f04e5..e9390630445 100644 --- a/src/libstd/ffi/os_str.rs +++ b/src/libstd/ffi/os_str.rs @@ -34,7 +34,9 @@ use sys_common::{AsInner, IntoInner, FromInner}; /// /// `OsString` and [`OsStr`] bridge this gap by simultaneously representing Rust /// and platform-native string values, and in particular allowing a Rust string -/// to be converted into an "OS" string with no cost if possible. +/// to be converted into an "OS" string with no cost if possible. A consequence +/// of this is that `OsString` instances are *not* `NUL` terminated; in order +/// to pass to e.g. Unix system call, you should create a [`CStr`]. /// /// `OsString` is to [`&OsStr`] as [`String`] is to [`&str`]: the former /// in each pair are owned strings; the latter are borrowed @@ -65,6 +67,7 @@ use sys_common::{AsInner, IntoInner, FromInner}; /// /// [`OsStr`]: struct.OsStr.html /// [`&OsStr`]: struct.OsStr.html +/// [`CStr`]: struct.CStr.html /// [`From`]: ../convert/trait.From.html /// [`String`]: ../string/struct.String.html /// [`&str`]: ../primitive.str.html |