1 // Copyright 2012 The Rust Project Developers. See the COPYRIGHT
2 // file at the top-level directory of this distribution and at
3 // http://rust-lang.org/COPYRIGHT.
5 // Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
6 // http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
7 // <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
8 // option. This file may not be copied, modified, or distributed
9 // except according to those terms.
12 use borrow::{Cow, ToOwned, Borrow};
14 use convert::{Into, From};
15 use cmp::{PartialEq, Eq, PartialOrd, Ord, Ordering};
17 use fmt::{self, Write};
23 use option::Option::{self, Some, None};
24 use result::Result::{self, Ok, Err};
30 /// A type representing an owned C-compatible string
32 /// This type serves the primary purpose of being able to safely generate a
33 /// C-compatible string from a Rust byte slice or vector. An instance of this
34 /// type is a static guarantee that the underlying bytes contain no interior 0
35 /// bytes and the final byte is 0.
37 /// A `CString` is created from either a byte slice or a byte vector. After
38 /// being created, a `CString` predominately inherits all of its methods from
39 /// the `Deref` implementation to `[libc::c_char]`. Note that the underlying
40 /// array is represented as an array of `libc::c_char` as opposed to `u8`. A
41 /// `u8` slice can be obtained with the `as_bytes` method. Slices produced from
42 /// a `CString` do *not* contain the trailing nul terminator unless otherwise
48 /// # #![feature(libc)]
49 /// # extern crate libc;
51 /// use std::ffi::CString;
55 /// fn my_printer(s: *const libc::c_char);
58 /// let c_to_print = CString::new("Hello, world!").unwrap();
60 /// my_printer(c_to_print.as_ptr());
64 #[derive(PartialEq, PartialOrd, Eq, Ord, Hash, Clone)]
65 #[stable(feature = "rust1", since = "1.0.0")]
70 /// Representation of a borrowed C string.
72 /// This dynamically sized type is only safely constructed via a borrowed
73 /// version of an instance of `CString`. This type can be constructed from a raw
74 /// C string as well and represents a C string borrowed from another location.
76 /// Note that this structure is **not** `repr(C)` and is not recommended to be
77 /// placed in the signatures of FFI functions. Instead safe wrappers of FFI
78 /// functions may leverage the unsafe `from_ptr` constructor to provide a safe
79 /// interface to other consumers.
83 /// Inspecting a foreign C string
86 /// # #![feature(libc)]
87 /// extern crate libc;
88 /// use std::ffi::CStr;
90 /// extern { fn my_string() -> *const libc::c_char; }
94 /// let slice = CStr::from_ptr(my_string());
95 /// println!("string length: {}", slice.to_bytes().len());
100 /// Passing a Rust-originating C string
103 /// # #![feature(libc)]
104 /// extern crate libc;
105 /// use std::ffi::{CString, CStr};
107 /// fn work(data: &CStr) {
108 /// extern { fn work_with(data: *const libc::c_char); }
110 /// unsafe { work_with(data.as_ptr()) }
114 /// let s = CString::new("data data data data").unwrap();
119 /// Converting a foreign C string into a Rust `String`
122 /// # #![feature(libc,cstr_to_str)]
123 /// extern crate libc;
124 /// use std::ffi::CStr;
126 /// extern { fn my_string() -> *const libc::c_char; }
128 /// fn my_string_safe() -> String {
130 /// CStr::from_ptr(my_string()).to_string_lossy().into_owned()
135 /// println!("string: {}", my_string_safe());
139 #[stable(feature = "rust1", since = "1.0.0")]
141 // FIXME: this should not be represented with a DST slice but rather with
142 // just a raw `libc::c_char` along with some form of marker to make
143 // this an unsized type. Essentially `sizeof(&CStr)` should be the
144 // same as `sizeof(&c_char)` but `CStr` should be an unsized type.
145 inner: [libc::c_char]
148 /// An error returned from `CString::new` to indicate that a nul byte was found
149 /// in the vector provided.
150 #[derive(Clone, PartialEq, Debug)]
151 #[stable(feature = "rust1", since = "1.0.0")]
152 pub struct NulError(usize, Vec<u8>);
155 /// Creates a new C-compatible string from a container of bytes.
157 /// This method will consume the provided data and use the underlying bytes
158 /// to construct a new string, ensuring that there is a trailing 0 byte.
163 /// # #![feature(libc)]
164 /// extern crate libc;
165 /// use std::ffi::CString;
167 /// extern { fn puts(s: *const libc::c_char); }
170 /// let to_print = CString::new("Hello!").unwrap();
172 /// puts(to_print.as_ptr());
179 /// This function will return an error if the bytes yielded contain an
180 /// internal 0 byte. The error returned will contain the bytes as well as
181 /// the position of the nul byte.
182 #[stable(feature = "rust1", since = "1.0.0")]
183 pub fn new<T: Into<Vec<u8>>>(t: T) -> Result<CString, NulError> {
184 let bytes = t.into();
185 match bytes.iter().position(|x| *x == 0) {
186 Some(i) => Err(NulError(i, bytes)),
187 None => Ok(unsafe { CString::from_vec_unchecked(bytes) }),
191 /// Creates a C-compatible string from a byte vector without checking for
192 /// interior 0 bytes.
194 /// This method is equivalent to `new` except that no runtime assertion
195 /// is made that `v` contains no 0 bytes, and it requires an actual
196 /// byte vector, not anything that can be converted to one with Into.
197 #[stable(feature = "rust1", since = "1.0.0")]
198 pub unsafe fn from_vec_unchecked(mut v: Vec<u8>) -> CString {
200 CString { inner: v.into_boxed_slice() }
203 /// Retakes ownership of a CString that was transferred to C.
205 /// The only appropriate argument is a pointer obtained by calling
206 /// `into_ptr`. The length of the string will be recalculated
207 /// using the pointer.
208 #[unstable(feature = "cstr_memory", reason = "recently added",
210 // NB: may want to be called from_raw, needs to consider CStr::from_ptr,
211 // Box::from_raw (or whatever it's currently called), and
212 // slice::from_raw_parts
213 pub unsafe fn from_ptr(ptr: *const libc::c_char) -> CString {
214 let len = libc::strlen(ptr) + 1; // Including the NUL byte
215 let slice = slice::from_raw_parts(ptr, len as usize);
216 CString { inner: mem::transmute(slice) }
219 /// Transfers ownership of the string to a C caller.
221 /// The pointer must be returned to Rust and reconstituted using
222 /// `from_ptr` to be properly deallocated. Specifically, one
223 /// should *not* use the standard C `free` function to deallocate
226 /// Failure to call `from_ptr` will lead to a memory leak.
227 #[unstable(feature = "cstr_memory", reason = "recently added",
229 // NB: may want to be called into_raw, see comments on from_ptr
230 pub fn into_ptr(self) -> *const libc::c_char {
231 // It is important that the bytes be sized to fit - we need
232 // the capacity to be determinable from the string length, and
233 // shrinking to fit is the only way to be sure.
234 Box::into_raw(self.inner) as *const libc::c_char
237 /// Returns the contents of this `CString` as a slice of bytes.
239 /// The returned slice does **not** contain the trailing nul separator and
240 /// it is guaranteed to not have any interior nul bytes.
241 #[stable(feature = "rust1", since = "1.0.0")]
242 pub fn as_bytes(&self) -> &[u8] {
243 &self.inner[..self.inner.len() - 1]
246 /// Equivalent to the `as_bytes` function except that the returned slice
247 /// includes the trailing nul byte.
248 #[stable(feature = "rust1", since = "1.0.0")]
249 pub fn as_bytes_with_nul(&self) -> &[u8] {
254 #[stable(feature = "rust1", since = "1.0.0")]
255 impl Deref for CString {
258 fn deref(&self) -> &CStr {
259 unsafe { mem::transmute(self.as_bytes_with_nul()) }
263 #[stable(feature = "rust1", since = "1.0.0")]
264 impl fmt::Debug for CString {
265 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
266 fmt::Debug::fmt(&**self, f)
270 #[stable(feature = "cstr_debug", since = "1.3.0")]
271 impl fmt::Debug for CStr {
272 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
273 try!(write!(f, "\""));
274 for byte in self.to_bytes().iter().flat_map(|&b| ascii::escape_default(b)) {
275 try!(f.write_char(byte as char));
281 #[stable(feature = "cstr_borrow", since = "1.3.0")]
282 impl Borrow<CStr> for CString {
283 fn borrow(&self) -> &CStr { self }
287 /// Returns the position of the nul byte in the slice that was provided to
289 #[stable(feature = "rust1", since = "1.0.0")]
290 pub fn nul_position(&self) -> usize { self.0 }
292 /// Consumes this error, returning the underlying vector of bytes which
293 /// generated the error in the first place.
294 #[stable(feature = "rust1", since = "1.0.0")]
295 pub fn into_vec(self) -> Vec<u8> { self.1 }
298 #[stable(feature = "rust1", since = "1.0.0")]
299 impl Error for NulError {
300 fn description(&self) -> &str { "nul byte found in data" }
303 #[stable(feature = "rust1", since = "1.0.0")]
304 impl fmt::Display for NulError {
305 fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
306 write!(f, "nul byte found in provided data at position: {}", self.0)
310 #[stable(feature = "rust1", since = "1.0.0")]
311 impl From<NulError> for io::Error {
312 fn from(_: NulError) -> io::Error {
313 io::Error::new(io::ErrorKind::InvalidInput,
314 "data provided contains a nul byte")
319 /// Casts a raw C string to a safe C string wrapper.
321 /// This function will cast the provided `ptr` to the `CStr` wrapper which
322 /// allows inspection and interoperation of non-owned C strings. This method
323 /// is unsafe for a number of reasons:
325 /// * There is no guarantee to the validity of `ptr`
326 /// * The returned lifetime is not guaranteed to be the actual lifetime of
328 /// * There is no guarantee that the memory pointed to by `ptr` contains a
329 /// valid nul terminator byte at the end of the string.
331 /// > **Note**: This operation is intended to be a 0-cost cast but it is
332 /// > currently implemented with an up-front calculation of the length of
333 /// > the string. This is not guaranteed to always be the case.
338 /// # #![feature(libc)]
339 /// # extern crate libc;
341 /// use std::ffi::CStr;
346 /// fn my_string() -> *const libc::c_char;
350 /// let slice = CStr::from_ptr(my_string());
351 /// println!("string returned: {}",
352 /// str::from_utf8(slice.to_bytes()).unwrap());
356 #[stable(feature = "rust1", since = "1.0.0")]
357 pub unsafe fn from_ptr<'a>(ptr: *const libc::c_char) -> &'a CStr {
358 let len = libc::strlen(ptr);
359 mem::transmute(slice::from_raw_parts(ptr, len as usize + 1))
362 /// Returns the inner pointer to this C string.
364 /// The returned pointer will be valid for as long as `self` is and points
365 /// to a contiguous region of memory terminated with a 0 byte to represent
366 /// the end of the string.
367 #[stable(feature = "rust1", since = "1.0.0")]
368 pub fn as_ptr(&self) -> *const libc::c_char {
372 /// Converts this C string to a byte slice.
374 /// This function will calculate the length of this string (which normally
375 /// requires a linear amount of work to be done) and then return the
376 /// resulting slice of `u8` elements.
378 /// The returned slice will **not** contain the trailing nul that this C
381 /// > **Note**: This method is currently implemented as a 0-cost cast, but
382 /// > it is planned to alter its definition in the future to perform the
383 /// > length calculation whenever this method is called.
384 #[stable(feature = "rust1", since = "1.0.0")]
385 pub fn to_bytes(&self) -> &[u8] {
386 let bytes = self.to_bytes_with_nul();
387 &bytes[..bytes.len() - 1]
390 /// Converts this C string to a byte slice containing the trailing 0 byte.
392 /// This function is the equivalent of `to_bytes` except that it will retain
393 /// the trailing nul instead of chopping it off.
395 /// > **Note**: This method is currently implemented as a 0-cost cast, but
396 /// > it is planned to alter its definition in the future to perform the
397 /// > length calculation whenever this method is called.
398 #[stable(feature = "rust1", since = "1.0.0")]
399 pub fn to_bytes_with_nul(&self) -> &[u8] {
400 unsafe { mem::transmute(&self.inner) }
403 /// Yields a `&str` slice if the `CStr` contains valid UTF-8.
405 /// This function will calculate the length of this string and check for
406 /// UTF-8 validity, and then return the `&str` if it's valid.
408 /// > **Note**: This method is currently implemented to check for validity
409 /// > after a 0-cost cast, but it is planned to alter its definition in the
410 /// > future to perform the length calculation in addition to the UTF-8
411 /// > check whenever this method is called.
412 #[unstable(feature = "cstr_to_str", reason = "recently added",
414 pub fn to_str(&self) -> Result<&str, str::Utf8Error> {
415 // NB: When CStr is changed to perform the length check in .to_bytes()
416 // instead of in from_ptr(), it may be worth considering if this should
417 // be rewritten to do the UTF-8 check inline with the length calculation
418 // instead of doing it afterwards.
419 str::from_utf8(self.to_bytes())
422 /// Converts a `CStr` into a `Cow<str>`.
424 /// This function will calculate the length of this string (which normally
425 /// requires a linear amount of work to be done) and then return the
426 /// resulting slice as a `Cow<str>`, replacing any invalid UTF-8 sequences
427 /// with `U+FFFD REPLACEMENT CHARACTER`.
429 /// > **Note**: This method is currently implemented to check for validity
430 /// > after a 0-cost cast, but it is planned to alter its definition in the
431 /// > future to perform the length calculation in addition to the UTF-8
432 /// > check whenever this method is called.
433 #[unstable(feature = "cstr_to_str", reason = "recently added",
435 pub fn to_string_lossy(&self) -> Cow<str> {
436 String::from_utf8_lossy(self.to_bytes())
440 #[stable(feature = "rust1", since = "1.0.0")]
441 impl PartialEq for CStr {
442 fn eq(&self, other: &CStr) -> bool {
443 self.to_bytes().eq(other.to_bytes())
446 #[stable(feature = "rust1", since = "1.0.0")]
448 #[stable(feature = "rust1", since = "1.0.0")]
449 impl PartialOrd for CStr {
450 fn partial_cmp(&self, other: &CStr) -> Option<Ordering> {
451 self.to_bytes().partial_cmp(&other.to_bytes())
454 #[stable(feature = "rust1", since = "1.0.0")]
456 fn cmp(&self, other: &CStr) -> Ordering {
457 self.to_bytes().cmp(&other.to_bytes())
461 #[stable(feature = "cstr_borrow", since = "1.3.0")]
462 impl ToOwned for CStr {
463 type Owned = CString;
465 fn to_owned(&self) -> CString {
466 unsafe { CString::from_vec_unchecked(self.to_bytes().to_vec()) }
475 use borrow::Cow::{Borrowed, Owned};
476 use hash::{SipHasher, Hash, Hasher};
481 let ptr = data.as_ptr() as *const libc::c_char;
483 assert_eq!(CStr::from_ptr(ptr).to_bytes(), b"123");
484 assert_eq!(CStr::from_ptr(ptr).to_bytes_with_nul(), b"123\0");
490 let s = CString::new("1234").unwrap();
491 assert_eq!(s.as_bytes(), b"1234");
492 assert_eq!(s.as_bytes_with_nul(), b"1234\0");
496 fn build_with_zero1() {
497 assert!(CString::new(&b"\0"[..]).is_err());
500 fn build_with_zero2() {
501 assert!(CString::new(vec![0]).is_err());
505 fn build_with_zero3() {
507 let s = CString::from_vec_unchecked(vec![0]);
508 assert_eq!(s.as_bytes(), b"\0");
514 let s = CString::new(&b"abc\x01\x02\n\xE2\x80\xA6\xFF"[..]).unwrap();
515 assert_eq!(format!("{:?}", s), r#""abc\x01\x02\n\xe2\x80\xa6\xff""#);
521 let s = CStr::from_ptr(b"12\0".as_ptr() as *const _);
522 assert_eq!(s.to_bytes(), b"12");
523 assert_eq!(s.to_bytes_with_nul(), b"12\0");
529 let data = b"123\xE2\x80\xA6\0";
530 let ptr = data.as_ptr() as *const libc::c_char;
532 assert_eq!(CStr::from_ptr(ptr).to_str(), Ok("123…"));
533 assert_eq!(CStr::from_ptr(ptr).to_string_lossy(), Borrowed("123…"));
535 let data = b"123\xE2\0";
536 let ptr = data.as_ptr() as *const libc::c_char;
538 assert!(CStr::from_ptr(ptr).to_str().is_err());
539 assert_eq!(CStr::from_ptr(ptr).to_string_lossy(), Owned::<str>(format!("123\u{FFFD}")));
546 let ptr = data.as_ptr() as *const libc::c_char;
548 let owned = unsafe { CStr::from_ptr(ptr).to_owned() };
549 assert_eq!(owned.as_bytes_with_nul(), data);
554 let data = b"123\xE2\xFA\xA6\0";
555 let ptr = data.as_ptr() as *const libc::c_char;
556 let cstr: &'static CStr = unsafe { CStr::from_ptr(ptr) };
558 let mut s = SipHasher::new_with_keys(0, 0);
560 let cstr_hash = s.finish();
561 let mut s = SipHasher::new_with_keys(0, 0);
562 CString::new(&data[..data.len() - 1]).unwrap().hash(&mut s);
563 let cstring_hash = s.finish();
565 assert_eq!(cstr_hash, cstring_hash);