]> git.lizzy.rs Git - rust.git/commit
std: Implement CString-related RFCs
authorAlex Crichton <alex@alexcrichton.com>
Wed, 18 Feb 2015 06:47:40 +0000 (22:47 -0800)
committerAlex Crichton <alex@alexcrichton.com>
Wed, 18 Feb 2015 22:15:43 +0000 (14:15 -0800)
commit1860ee521aa6096eb7f5410a64b53311fb0d2d0e
treeaab78365cf67ad032ac8cf6bfc723677ba2b4421
parentdfc5c0f1e8799f47f9033bdcc8a7cd8a217620a5
std: Implement CString-related RFCs

This commit is an implementation of [RFC 592][r592] and [RFC 840][r840]. These
two RFCs tweak the behavior of `CString` and add a new `CStr` unsized slice type
to the module.

[r592]: https://github.com/rust-lang/rfcs/blob/master/text/0592-c-str-deref.md
[r840]: https://github.com/rust-lang/rfcs/blob/master/text/0840-no-panic-in-c-string.md

The new `CStr` type is only constructable via two methods:

1. By `deref`'ing from a `CString`
2. Unsafely via `CStr::from_ptr`

The purpose of `CStr` is to be an unsized type which is a thin pointer to a
`libc::c_char` (currently it is a fat pointer slice due to implementation
limitations). Strings from C can be safely represented with a `CStr` and an
appropriate lifetime as well. Consumers of `&CString` should now consume `&CStr`
instead to allow producers to pass in C-originating strings instead of just
Rust-allocated strings.

A new constructor was added to `CString`, `new`, which takes `T: IntoBytes`
instead of separate `from_slice` and `from_vec` methods (both have been
deprecated in favor of `new`). The `new` method returns a `Result` instead of
panicking.  The error variant contains the relevant information about where the
error happened and bytes (if present). Conversions are provided to the
`io::Error` and `old_io::IoError` types via the `FromError` trait which
translate to `InvalidInput`.

This is a breaking change due to the modification of existing `#[unstable]` APIs
and new deprecation, and more detailed information can be found in the two RFCs.
Notable breakage includes:

* All construction of `CString` now needs to use `new` and handle the outgoing
  `Result`.
* Usage of `CString` as a byte slice now explicitly needs a `.as_bytes()` call.
* The `as_slice*` methods have been removed in favor of just having the
  `as_bytes*` methods.

Closes #22469
Closes #22470
[breaking-change]
40 files changed:
src/doc/trpl/ffi.md
src/librustc/metadata/loader.rs
src/librustc_llvm/archive_ro.rs
src/librustc_llvm/lib.rs
src/librustc_trans/back/lto.rs
src/librustc_trans/back/write.rs
src/librustc_trans/trans/asm.rs
src/librustc_trans/trans/base.rs
src/librustc_trans/trans/builder.rs
src/librustc_trans/trans/common.rs
src/librustc_trans/trans/context.rs
src/librustc_trans/trans/debuginfo.rs
src/librustc_trans/trans/foreign.rs
src/librustc_trans/trans/glue.rs
src/librustc_trans/trans/type_.rs
src/librustdoc/flock.rs
src/librustdoc/html/markdown.rs
src/libstd/dynamic_lib.rs
src/libstd/ffi/c_str.rs
src/libstd/ffi/mod.rs
src/libstd/old_io/net/pipe.rs
src/libstd/old_io/process.rs
src/libstd/rt/args.rs
src/libstd/sys/common/net.rs
src/libstd/sys/common/net2.rs
src/libstd/sys/unix/backtrace.rs
src/libstd/sys/unix/ext.rs
src/libstd/sys/unix/fs.rs
src/libstd/sys/unix/fs2.rs
src/libstd/sys/unix/mod.rs
src/libstd/sys/unix/net.rs
src/libstd/sys/unix/os.rs
src/libstd/sys/unix/pipe.rs
src/libstd/sys/unix/process2.rs
src/libstd/sys/unix/thread.rs
src/libsyntax/diagnostic.rs
src/test/run-pass/c-stack-returning-int64.rs
src/test/run-pass/foreign-fn-linkname.rs
src/test/run-pass/rename-directory.rs
src/test/run-pass/variadic-ffi.rs