2013-08-03 19:13:14 -05:00
|
|
|
// Copyright 2012 The Rust Project Developers. See the COPYRIGHT
|
|
|
|
// file at the top-level directory of this distribution and at
|
|
|
|
// http://rust-lang.org/COPYRIGHT.
|
|
|
|
//
|
|
|
|
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
|
|
|
|
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
|
|
|
|
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
|
|
|
|
// option. This file may not be copied, modified, or distributed
|
|
|
|
// except according to those terms.
|
|
|
|
|
2013-09-17 21:42:07 -05:00
|
|
|
/*!
|
|
|
|
|
|
|
|
C-string manipulation and management
|
|
|
|
|
|
|
|
This modules provides the basic methods for creating and manipulating
|
|
|
|
null-terminated strings for use with FFI calls (back to C). Most C APIs require
|
|
|
|
that the string being passed to them is null-terminated, and by default rust's
|
|
|
|
string types are *not* null terminated.
|
|
|
|
|
|
|
|
The other problem with translating Rust strings to C strings is that Rust
|
|
|
|
strings can validly contain a null-byte in the middle of the string (0 is a
|
|
|
|
valid unicode codepoint). This means that not all Rust strings can actually be
|
|
|
|
translated to C strings.
|
|
|
|
|
|
|
|
# Creation of a C string
|
|
|
|
|
|
|
|
A C string is managed through the `CString` type defined in this module. It
|
|
|
|
"owns" the internal buffer of characters and will automatically deallocate the
|
|
|
|
buffer when the string is dropped. The `ToCStr` trait is implemented for `&str`
|
|
|
|
and `&[u8]`, but the conversions can fail due to some of the limitations
|
|
|
|
explained above.
|
|
|
|
|
|
|
|
This also means that currently whenever a C string is created, an allocation
|
|
|
|
must be performed to place the data elsewhere (the lifetime of the C string is
|
|
|
|
not tied to the lifetime of the original string/data buffer). If C strings are
|
|
|
|
heavily used in applications, then caching may be advisable to prevent
|
|
|
|
unnecessary amounts of allocations.
|
|
|
|
|
|
|
|
An example of creating and using a C string would be:
|
|
|
|
|
2013-09-23 19:20:36 -05:00
|
|
|
```rust
|
2014-02-26 11:58:41 -06:00
|
|
|
extern crate libc;
|
|
|
|
|
2013-11-06 17:16:04 -06:00
|
|
|
extern {
|
|
|
|
fn puts(s: *libc::c_char);
|
|
|
|
}
|
2013-09-17 21:42:07 -05:00
|
|
|
|
2014-02-26 11:58:41 -06:00
|
|
|
fn main() {
|
|
|
|
let my_string = "Hello, world!";
|
|
|
|
|
|
|
|
// Allocate the C string with an explicit local that owns the string. The
|
|
|
|
// `c_buffer` pointer will be deallocated when `my_c_string` goes out of scope.
|
|
|
|
let my_c_string = my_string.to_c_str();
|
|
|
|
my_c_string.with_ref(|c_buffer| {
|
|
|
|
unsafe { puts(c_buffer); }
|
|
|
|
});
|
|
|
|
|
|
|
|
// Don't save off the allocation of the C string, the `c_buffer` will be
|
|
|
|
// deallocated when this block returns!
|
|
|
|
my_string.with_c_str(|c_buffer| {
|
|
|
|
unsafe { puts(c_buffer); }
|
|
|
|
});
|
|
|
|
}
|
2014-05-02 19:56:35 -05:00
|
|
|
```
|
2013-09-17 21:42:07 -05:00
|
|
|
|
|
|
|
*/
|
|
|
|
|
core: Remove the cast module
This commit revisits the `cast` module in libcore and libstd, and scrutinizes
all functions inside of it. The result was to remove the `cast` module entirely,
folding all functionality into the `mem` module. Specifically, this is the fate
of each function in the `cast` module.
* transmute - This function was moved to `mem`, but it is now marked as
#[unstable]. This is due to planned changes to the `transmute`
function and how it can be invoked (see the #[unstable] comment).
For more information, see RFC 5 and #12898
* transmute_copy - This function was moved to `mem`, with clarification that is
is not an error to invoke it with T/U that are different
sizes, but rather that it is strongly discouraged. This
function is now #[stable]
* forget - This function was moved to `mem` and marked #[stable]
* bump_box_refcount - This function was removed due to the deprecation of
managed boxes as well as its questionable utility.
* transmute_mut - This function was previously deprecated, and removed as part
of this commit.
* transmute_mut_unsafe - This function doesn't serve much of a purpose when it
can be achieved with an `as` in safe code, so it was
removed.
* transmute_lifetime - This function was removed because it is likely a strong
indication that code is incorrect in the first place.
* transmute_mut_lifetime - This function was removed for the same reasons as
`transmute_lifetime`
* copy_lifetime - This function was moved to `mem`, but it is marked
`#[unstable]` now due to the likelihood of being removed in
the future if it is found to not be very useful.
* copy_mut_lifetime - This function was also moved to `mem`, but had the same
treatment as `copy_lifetime`.
* copy_lifetime_vec - This function was removed because it is not used today,
and its existence is not necessary with DST
(copy_lifetime will suffice).
In summary, the cast module was stripped down to these functions, and then the
functions were moved to the `mem` module.
transmute - #[unstable]
transmute_copy - #[stable]
forget - #[stable]
copy_lifetime - #[unstable]
copy_mut_lifetime - #[unstable]
[breaking-change]
2014-05-09 12:34:51 -05:00
|
|
|
use clone::Clone;
|
2014-05-29 19:45:07 -05:00
|
|
|
use cmp::PartialEq;
|
2013-09-18 14:32:35 -05:00
|
|
|
use container::Container;
|
2013-09-08 10:01:16 -05:00
|
|
|
use iter::{Iterator, range};
|
2014-01-22 13:03:02 -06:00
|
|
|
use kinds::marker;
|
core: Remove the cast module
This commit revisits the `cast` module in libcore and libstd, and scrutinizes
all functions inside of it. The result was to remove the `cast` module entirely,
folding all functionality into the `mem` module. Specifically, this is the fate
of each function in the `cast` module.
* transmute - This function was moved to `mem`, but it is now marked as
#[unstable]. This is due to planned changes to the `transmute`
function and how it can be invoked (see the #[unstable] comment).
For more information, see RFC 5 and #12898
* transmute_copy - This function was moved to `mem`, with clarification that is
is not an error to invoke it with T/U that are different
sizes, but rather that it is strongly discouraged. This
function is now #[stable]
* forget - This function was moved to `mem` and marked #[stable]
* bump_box_refcount - This function was removed due to the deprecation of
managed boxes as well as its questionable utility.
* transmute_mut - This function was previously deprecated, and removed as part
of this commit.
* transmute_mut_unsafe - This function doesn't serve much of a purpose when it
can be achieved with an `as` in safe code, so it was
removed.
* transmute_lifetime - This function was removed because it is likely a strong
indication that code is incorrect in the first place.
* transmute_mut_lifetime - This function was removed for the same reasons as
`transmute_lifetime`
* copy_lifetime - This function was moved to `mem`, but it is marked
`#[unstable]` now due to the likelihood of being removed in
the future if it is found to not be very useful.
* copy_mut_lifetime - This function was also moved to `mem`, but had the same
treatment as `copy_lifetime`.
* copy_lifetime_vec - This function was removed because it is not used today,
and its existence is not necessary with DST
(copy_lifetime will suffice).
In summary, the cast module was stripped down to these functions, and then the
functions were moved to the `mem` module.
transmute - #[unstable]
transmute_copy - #[stable]
forget - #[stable]
copy_lifetime - #[unstable]
copy_mut_lifetime - #[unstable]
[breaking-change]
2014-05-09 12:34:51 -05:00
|
|
|
use libc;
|
2014-02-08 04:46:55 -06:00
|
|
|
use mem;
|
core: Remove the cast module
This commit revisits the `cast` module in libcore and libstd, and scrutinizes
all functions inside of it. The result was to remove the `cast` module entirely,
folding all functionality into the `mem` module. Specifically, this is the fate
of each function in the `cast` module.
* transmute - This function was moved to `mem`, but it is now marked as
#[unstable]. This is due to planned changes to the `transmute`
function and how it can be invoked (see the #[unstable] comment).
For more information, see RFC 5 and #12898
* transmute_copy - This function was moved to `mem`, with clarification that is
is not an error to invoke it with T/U that are different
sizes, but rather that it is strongly discouraged. This
function is now #[stable]
* forget - This function was moved to `mem` and marked #[stable]
* bump_box_refcount - This function was removed due to the deprecation of
managed boxes as well as its questionable utility.
* transmute_mut - This function was previously deprecated, and removed as part
of this commit.
* transmute_mut_unsafe - This function doesn't serve much of a purpose when it
can be achieved with an `as` in safe code, so it was
removed.
* transmute_lifetime - This function was removed because it is likely a strong
indication that code is incorrect in the first place.
* transmute_mut_lifetime - This function was removed for the same reasons as
`transmute_lifetime`
* copy_lifetime - This function was moved to `mem`, but it is marked
`#[unstable]` now due to the likelihood of being removed in
the future if it is found to not be very useful.
* copy_mut_lifetime - This function was also moved to `mem`, but had the same
treatment as `copy_lifetime`.
* copy_lifetime_vec - This function was removed because it is not used today,
and its existence is not necessary with DST
(copy_lifetime will suffice).
In summary, the cast module was stripped down to these functions, and then the
functions were moved to the `mem` module.
transmute - #[unstable]
transmute_copy - #[stable]
forget - #[stable]
copy_lifetime - #[unstable]
copy_mut_lifetime - #[unstable]
[breaking-change]
2014-05-09 12:34:51 -05:00
|
|
|
use ops::Drop;
|
2013-08-03 19:13:14 -05:00
|
|
|
use option::{Option, Some, None};
|
|
|
|
use ptr::RawPtr;
|
|
|
|
use ptr;
|
core: Remove the cast module
This commit revisits the `cast` module in libcore and libstd, and scrutinizes
all functions inside of it. The result was to remove the `cast` module entirely,
folding all functionality into the `mem` module. Specifically, this is the fate
of each function in the `cast` module.
* transmute - This function was moved to `mem`, but it is now marked as
#[unstable]. This is due to planned changes to the `transmute`
function and how it can be invoked (see the #[unstable] comment).
For more information, see RFC 5 and #12898
* transmute_copy - This function was moved to `mem`, with clarification that is
is not an error to invoke it with T/U that are different
sizes, but rather that it is strongly discouraged. This
function is now #[stable]
* forget - This function was moved to `mem` and marked #[stable]
* bump_box_refcount - This function was removed due to the deprecation of
managed boxes as well as its questionable utility.
* transmute_mut - This function was previously deprecated, and removed as part
of this commit.
* transmute_mut_unsafe - This function doesn't serve much of a purpose when it
can be achieved with an `as` in safe code, so it was
removed.
* transmute_lifetime - This function was removed because it is likely a strong
indication that code is incorrect in the first place.
* transmute_mut_lifetime - This function was removed for the same reasons as
`transmute_lifetime`
* copy_lifetime - This function was moved to `mem`, but it is marked
`#[unstable]` now due to the likelihood of being removed in
the future if it is found to not be very useful.
* copy_mut_lifetime - This function was also moved to `mem`, but had the same
treatment as `copy_lifetime`.
* copy_lifetime_vec - This function was removed because it is not used today,
and its existence is not necessary with DST
(copy_lifetime will suffice).
In summary, the cast module was stripped down to these functions, and then the
functions were moved to the `mem` module.
transmute - #[unstable]
transmute_copy - #[stable]
forget - #[stable]
copy_lifetime - #[unstable]
copy_mut_lifetime - #[unstable]
[breaking-change]
2014-05-09 12:34:51 -05:00
|
|
|
use raw::Slice;
|
|
|
|
use rt::libc_heap::malloc_raw;
|
2014-03-08 17:11:52 -06:00
|
|
|
use slice::{ImmutableVector, MutableVector};
|
|
|
|
use slice;
|
core: Remove the cast module
This commit revisits the `cast` module in libcore and libstd, and scrutinizes
all functions inside of it. The result was to remove the `cast` module entirely,
folding all functionality into the `mem` module. Specifically, this is the fate
of each function in the `cast` module.
* transmute - This function was moved to `mem`, but it is now marked as
#[unstable]. This is due to planned changes to the `transmute`
function and how it can be invoked (see the #[unstable] comment).
For more information, see RFC 5 and #12898
* transmute_copy - This function was moved to `mem`, with clarification that is
is not an error to invoke it with T/U that are different
sizes, but rather that it is strongly discouraged. This
function is now #[stable]
* forget - This function was moved to `mem` and marked #[stable]
* bump_box_refcount - This function was removed due to the deprecation of
managed boxes as well as its questionable utility.
* transmute_mut - This function was previously deprecated, and removed as part
of this commit.
* transmute_mut_unsafe - This function doesn't serve much of a purpose when it
can be achieved with an `as` in safe code, so it was
removed.
* transmute_lifetime - This function was removed because it is likely a strong
indication that code is incorrect in the first place.
* transmute_mut_lifetime - This function was removed for the same reasons as
`transmute_lifetime`
* copy_lifetime - This function was moved to `mem`, but it is marked
`#[unstable]` now due to the likelihood of being removed in
the future if it is found to not be very useful.
* copy_mut_lifetime - This function was also moved to `mem`, but had the same
treatment as `copy_lifetime`.
* copy_lifetime_vec - This function was removed because it is not used today,
and its existence is not necessary with DST
(copy_lifetime will suffice).
In summary, the cast module was stripped down to these functions, and then the
functions were moved to the `mem` module.
transmute - #[unstable]
transmute_copy - #[stable]
forget - #[stable]
copy_lifetime - #[unstable]
copy_mut_lifetime - #[unstable]
[breaking-change]
2014-05-09 12:34:51 -05:00
|
|
|
use str::StrSlice;
|
|
|
|
use str;
|
2014-05-22 18:57:53 -05:00
|
|
|
use string::String;
|
2013-08-14 21:19:29 -05:00
|
|
|
|
2013-08-04 20:37:55 -05:00
|
|
|
/// The representation of a C String.
|
|
|
|
///
|
|
|
|
/// This structure wraps a `*libc::c_char`, and will automatically free the
|
|
|
|
/// memory it is pointing to when it goes out of scope.
|
2013-08-03 19:13:14 -05:00
|
|
|
pub struct CString {
|
2014-03-27 17:09:47 -05:00
|
|
|
buf: *libc::c_char,
|
|
|
|
owns_buffer_: bool,
|
2013-08-03 19:13:14 -05:00
|
|
|
}
|
|
|
|
|
2014-01-27 05:12:59 -06:00
|
|
|
impl Clone for CString {
|
|
|
|
/// Clone this CString into a new, uniquely owned CString. For safety
|
|
|
|
/// reasons, this is always a deep clone, rather than the usual shallow
|
|
|
|
/// clone.
|
|
|
|
fn clone(&self) -> CString {
|
|
|
|
if self.buf.is_null() {
|
|
|
|
CString { buf: self.buf, owns_buffer_: self.owns_buffer_ }
|
|
|
|
} else {
|
2014-01-30 18:10:07 -06:00
|
|
|
let len = self.len() + 1;
|
|
|
|
let buf = unsafe { malloc_raw(len) } as *mut libc::c_char;
|
|
|
|
unsafe { ptr::copy_nonoverlapping_memory(buf, self.buf, len); }
|
2014-01-27 05:12:59 -06:00
|
|
|
CString { buf: buf as *libc::c_char, owns_buffer_: true }
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2014-05-29 19:45:07 -05:00
|
|
|
impl PartialEq for CString {
|
2014-01-30 18:10:07 -06:00
|
|
|
fn eq(&self, other: &CString) -> bool {
|
|
|
|
if self.buf as uint == other.buf as uint {
|
|
|
|
true
|
|
|
|
} else if self.buf.is_null() || other.buf.is_null() {
|
|
|
|
false
|
|
|
|
} else {
|
|
|
|
unsafe {
|
|
|
|
libc::strcmp(self.buf, other.buf) == 0
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-08-05 21:55:07 -05:00
|
|
|
impl CString {
|
2013-08-04 20:37:55 -05:00
|
|
|
/// Create a C String from a pointer.
|
2013-08-06 23:11:10 -05:00
|
|
|
pub unsafe fn new(buf: *libc::c_char, owns_buffer: bool) -> CString {
|
2013-08-04 20:37:55 -05:00
|
|
|
CString { buf: buf, owns_buffer_: owns_buffer }
|
2013-08-03 19:13:14 -05:00
|
|
|
}
|
|
|
|
|
2013-08-04 20:37:55 -05:00
|
|
|
/// Unwraps the wrapped `*libc::c_char` from the `CString` wrapper.
|
2013-08-14 21:18:24 -05:00
|
|
|
/// Any ownership of the buffer by the `CString` wrapper is forgotten.
|
2013-08-04 20:37:55 -05:00
|
|
|
pub unsafe fn unwrap(self) -> *libc::c_char {
|
|
|
|
let mut c_str = self;
|
|
|
|
c_str.owns_buffer_ = false;
|
|
|
|
c_str.buf
|
2013-08-03 19:13:14 -05:00
|
|
|
}
|
|
|
|
|
2013-08-04 20:37:55 -05:00
|
|
|
/// Calls a closure with a reference to the underlying `*libc::c_char`.
|
|
|
|
///
|
|
|
|
/// # Failure
|
|
|
|
///
|
|
|
|
/// Fails if the CString is null.
|
2013-11-18 23:15:42 -06:00
|
|
|
pub fn with_ref<T>(&self, f: |*libc::c_char| -> T) -> T {
|
2013-10-21 15:08:31 -05:00
|
|
|
if self.buf.is_null() { fail!("CString is null!"); }
|
2013-08-03 19:13:14 -05:00
|
|
|
f(self.buf)
|
|
|
|
}
|
|
|
|
|
2013-08-04 20:37:55 -05:00
|
|
|
/// Calls a closure with a mutable reference to the underlying `*libc::c_char`.
|
|
|
|
///
|
|
|
|
/// # Failure
|
|
|
|
///
|
|
|
|
/// Fails if the CString is null.
|
2013-11-18 23:15:42 -06:00
|
|
|
pub fn with_mut_ref<T>(&mut self, f: |*mut libc::c_char| -> T) -> T {
|
2013-10-21 15:08:31 -05:00
|
|
|
if self.buf.is_null() { fail!("CString is null!"); }
|
core: Remove the cast module
This commit revisits the `cast` module in libcore and libstd, and scrutinizes
all functions inside of it. The result was to remove the `cast` module entirely,
folding all functionality into the `mem` module. Specifically, this is the fate
of each function in the `cast` module.
* transmute - This function was moved to `mem`, but it is now marked as
#[unstable]. This is due to planned changes to the `transmute`
function and how it can be invoked (see the #[unstable] comment).
For more information, see RFC 5 and #12898
* transmute_copy - This function was moved to `mem`, with clarification that is
is not an error to invoke it with T/U that are different
sizes, but rather that it is strongly discouraged. This
function is now #[stable]
* forget - This function was moved to `mem` and marked #[stable]
* bump_box_refcount - This function was removed due to the deprecation of
managed boxes as well as its questionable utility.
* transmute_mut - This function was previously deprecated, and removed as part
of this commit.
* transmute_mut_unsafe - This function doesn't serve much of a purpose when it
can be achieved with an `as` in safe code, so it was
removed.
* transmute_lifetime - This function was removed because it is likely a strong
indication that code is incorrect in the first place.
* transmute_mut_lifetime - This function was removed for the same reasons as
`transmute_lifetime`
* copy_lifetime - This function was moved to `mem`, but it is marked
`#[unstable]` now due to the likelihood of being removed in
the future if it is found to not be very useful.
* copy_mut_lifetime - This function was also moved to `mem`, but had the same
treatment as `copy_lifetime`.
* copy_lifetime_vec - This function was removed because it is not used today,
and its existence is not necessary with DST
(copy_lifetime will suffice).
In summary, the cast module was stripped down to these functions, and then the
functions were moved to the `mem` module.
transmute - #[unstable]
transmute_copy - #[stable]
forget - #[stable]
copy_lifetime - #[unstable]
copy_mut_lifetime - #[unstable]
[breaking-change]
2014-05-09 12:34:51 -05:00
|
|
|
f(self.buf as *mut libc::c_char)
|
2013-08-03 19:13:14 -05:00
|
|
|
}
|
|
|
|
|
2013-08-04 20:37:55 -05:00
|
|
|
/// Returns true if the CString is a null.
|
|
|
|
pub fn is_null(&self) -> bool {
|
2013-08-03 19:13:14 -05:00
|
|
|
self.buf.is_null()
|
|
|
|
}
|
|
|
|
|
2013-08-04 20:37:55 -05:00
|
|
|
/// Returns true if the CString is not null.
|
|
|
|
pub fn is_not_null(&self) -> bool {
|
2013-08-03 19:13:14 -05:00
|
|
|
self.buf.is_not_null()
|
|
|
|
}
|
|
|
|
|
2013-08-04 20:37:55 -05:00
|
|
|
/// Returns whether or not the `CString` owns the buffer.
|
|
|
|
pub fn owns_buffer(&self) -> bool {
|
|
|
|
self.owns_buffer_
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Converts the CString into a `&[u8]` without copying.
|
2014-02-14 17:42:35 -06:00
|
|
|
/// Includes the terminating NUL byte.
|
2013-08-04 20:37:55 -05:00
|
|
|
///
|
|
|
|
/// # Failure
|
|
|
|
///
|
|
|
|
/// Fails if the CString is null.
|
2013-09-15 22:30:03 -05:00
|
|
|
#[inline]
|
2013-08-05 21:55:07 -05:00
|
|
|
pub fn as_bytes<'a>(&'a self) -> &'a [u8] {
|
2013-10-21 15:08:31 -05:00
|
|
|
if self.buf.is_null() { fail!("CString is null!"); }
|
2013-08-03 19:13:14 -05:00
|
|
|
unsafe {
|
core: Remove the cast module
This commit revisits the `cast` module in libcore and libstd, and scrutinizes
all functions inside of it. The result was to remove the `cast` module entirely,
folding all functionality into the `mem` module. Specifically, this is the fate
of each function in the `cast` module.
* transmute - This function was moved to `mem`, but it is now marked as
#[unstable]. This is due to planned changes to the `transmute`
function and how it can be invoked (see the #[unstable] comment).
For more information, see RFC 5 and #12898
* transmute_copy - This function was moved to `mem`, with clarification that is
is not an error to invoke it with T/U that are different
sizes, but rather that it is strongly discouraged. This
function is now #[stable]
* forget - This function was moved to `mem` and marked #[stable]
* bump_box_refcount - This function was removed due to the deprecation of
managed boxes as well as its questionable utility.
* transmute_mut - This function was previously deprecated, and removed as part
of this commit.
* transmute_mut_unsafe - This function doesn't serve much of a purpose when it
can be achieved with an `as` in safe code, so it was
removed.
* transmute_lifetime - This function was removed because it is likely a strong
indication that code is incorrect in the first place.
* transmute_mut_lifetime - This function was removed for the same reasons as
`transmute_lifetime`
* copy_lifetime - This function was moved to `mem`, but it is marked
`#[unstable]` now due to the likelihood of being removed in
the future if it is found to not be very useful.
* copy_mut_lifetime - This function was also moved to `mem`, but had the same
treatment as `copy_lifetime`.
* copy_lifetime_vec - This function was removed because it is not used today,
and its existence is not necessary with DST
(copy_lifetime will suffice).
In summary, the cast module was stripped down to these functions, and then the
functions were moved to the `mem` module.
transmute - #[unstable]
transmute_copy - #[stable]
forget - #[stable]
copy_lifetime - #[unstable]
copy_mut_lifetime - #[unstable]
[breaking-change]
2014-05-09 12:34:51 -05:00
|
|
|
mem::transmute(Slice { data: self.buf, len: self.len() + 1 })
|
2014-02-14 17:42:35 -06:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Converts the CString into a `&[u8]` without copying.
|
|
|
|
/// Does not include the terminating NUL byte.
|
|
|
|
///
|
|
|
|
/// # Failure
|
|
|
|
///
|
|
|
|
/// Fails if the CString is null.
|
|
|
|
#[inline]
|
|
|
|
pub fn as_bytes_no_nul<'a>(&'a self) -> &'a [u8] {
|
|
|
|
if self.buf.is_null() { fail!("CString is null!"); }
|
|
|
|
unsafe {
|
core: Remove the cast module
This commit revisits the `cast` module in libcore and libstd, and scrutinizes
all functions inside of it. The result was to remove the `cast` module entirely,
folding all functionality into the `mem` module. Specifically, this is the fate
of each function in the `cast` module.
* transmute - This function was moved to `mem`, but it is now marked as
#[unstable]. This is due to planned changes to the `transmute`
function and how it can be invoked (see the #[unstable] comment).
For more information, see RFC 5 and #12898
* transmute_copy - This function was moved to `mem`, with clarification that is
is not an error to invoke it with T/U that are different
sizes, but rather that it is strongly discouraged. This
function is now #[stable]
* forget - This function was moved to `mem` and marked #[stable]
* bump_box_refcount - This function was removed due to the deprecation of
managed boxes as well as its questionable utility.
* transmute_mut - This function was previously deprecated, and removed as part
of this commit.
* transmute_mut_unsafe - This function doesn't serve much of a purpose when it
can be achieved with an `as` in safe code, so it was
removed.
* transmute_lifetime - This function was removed because it is likely a strong
indication that code is incorrect in the first place.
* transmute_mut_lifetime - This function was removed for the same reasons as
`transmute_lifetime`
* copy_lifetime - This function was moved to `mem`, but it is marked
`#[unstable]` now due to the likelihood of being removed in
the future if it is found to not be very useful.
* copy_mut_lifetime - This function was also moved to `mem`, but had the same
treatment as `copy_lifetime`.
* copy_lifetime_vec - This function was removed because it is not used today,
and its existence is not necessary with DST
(copy_lifetime will suffice).
In summary, the cast module was stripped down to these functions, and then the
functions were moved to the `mem` module.
transmute - #[unstable]
transmute_copy - #[stable]
forget - #[stable]
copy_lifetime - #[unstable]
copy_mut_lifetime - #[unstable]
[breaking-change]
2014-05-09 12:34:51 -05:00
|
|
|
mem::transmute(Slice { data: self.buf, len: self.len() })
|
2013-08-03 19:13:14 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-09-15 22:30:03 -05:00
|
|
|
/// Converts the CString into a `&str` without copying.
|
2014-01-30 17:29:36 -06:00
|
|
|
/// Returns None if the CString is not UTF-8.
|
|
|
|
///
|
|
|
|
/// # Failure
|
|
|
|
///
|
|
|
|
/// Fails if the CString is null.
|
2013-09-15 22:30:03 -05:00
|
|
|
#[inline]
|
|
|
|
pub fn as_str<'a>(&'a self) -> Option<&'a str> {
|
2014-02-14 17:42:35 -06:00
|
|
|
let buf = self.as_bytes_no_nul();
|
2013-12-23 10:30:49 -06:00
|
|
|
str::from_utf8(buf)
|
2013-09-15 22:30:03 -05:00
|
|
|
}
|
|
|
|
|
2013-08-04 20:37:55 -05:00
|
|
|
/// Return a CString iterator.
|
2014-01-30 17:29:36 -06:00
|
|
|
///
|
|
|
|
/// # Failure
|
|
|
|
///
|
|
|
|
/// Fails if the CString is null.
|
2014-01-14 21:32:24 -06:00
|
|
|
pub fn iter<'a>(&'a self) -> CChars<'a> {
|
2014-01-30 17:29:36 -06:00
|
|
|
if self.buf.is_null() { fail!("CString is null!"); }
|
2014-01-14 21:32:24 -06:00
|
|
|
CChars {
|
2013-08-03 19:13:14 -05:00
|
|
|
ptr: self.buf,
|
2014-01-22 13:03:02 -06:00
|
|
|
marker: marker::ContravariantLifetime,
|
2013-08-03 19:13:14 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
impl Drop for CString {
|
2013-09-16 20:18:07 -05:00
|
|
|
fn drop(&mut self) {
|
2013-08-06 23:08:39 -05:00
|
|
|
if self.owns_buffer_ {
|
2013-08-03 19:13:14 -05:00
|
|
|
unsafe {
|
2014-01-21 08:31:32 -06:00
|
|
|
libc::free(self.buf as *mut libc::c_void)
|
2013-08-04 20:37:55 -05:00
|
|
|
}
|
2013-08-03 19:13:14 -05:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-09-18 14:21:30 -05:00
|
|
|
impl Container for CString {
|
2014-01-30 17:29:36 -06:00
|
|
|
/// Return the number of bytes in the CString (not including the NUL terminator).
|
|
|
|
///
|
|
|
|
/// # Failure
|
|
|
|
///
|
|
|
|
/// Fails if the CString is null.
|
2013-09-18 14:21:30 -05:00
|
|
|
#[inline]
|
|
|
|
fn len(&self) -> uint {
|
2014-01-30 17:29:36 -06:00
|
|
|
if self.buf.is_null() { fail!("CString is null!"); }
|
2013-09-18 14:21:30 -05:00
|
|
|
unsafe {
|
|
|
|
ptr::position(self.buf, |c| *c == 0)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-08-04 20:37:55 -05:00
|
|
|
/// A generic trait for converting a value to a CString.
|
2013-08-03 19:13:14 -05:00
|
|
|
pub trait ToCStr {
|
2013-08-14 21:19:29 -05:00
|
|
|
/// Copy the receiver into a CString.
|
|
|
|
///
|
|
|
|
/// # Failure
|
|
|
|
///
|
Remove std::condition
This has been a long time coming. Conditions in rust were initially envisioned
as being a good alternative to error code return pattern. The idea is that all
errors are fatal-by-default, and you can opt-in to handling the error by
registering an error handler.
While sounding nice, conditions ended up having some unforseen shortcomings:
* Actually handling an error has some very awkward syntax:
let mut result = None;
let mut answer = None;
io::io_error::cond.trap(|e| { result = Some(e) }).inside(|| {
answer = Some(some_io_operation());
});
match result {
Some(err) => { /* hit an I/O error */ }
None => {
let answer = answer.unwrap();
/* deal with the result of I/O */
}
}
This pattern can certainly use functions like io::result, but at its core
actually handling conditions is fairly difficult
* The "zero value" of a function is often confusing. One of the main ideas
behind using conditions was to change the signature of I/O functions. Instead
of read_be_u32() returning a result, it returned a u32. Errors were notified
via a condition, and if you caught the condition you understood that the "zero
value" returned is actually a garbage value. These zero values are often
difficult to understand, however.
One case of this is the read_bytes() function. The function takes an integer
length of the amount of bytes to read, and returns an array of that size. The
array may actually be shorter, however, if an error occurred.
Another case is fs::stat(). The theoretical "zero value" is a blank stat
struct, but it's a little awkward to create and return a zero'd out stat
struct on a call to stat().
In general, the return value of functions that can raise error are much more
natural when using a Result as opposed to an always-usable zero-value.
* Conditions impose a necessary runtime requirement on *all* I/O. In theory I/O
is as simple as calling read() and write(), but using conditions imposed the
restriction that a rust local task was required if you wanted to catch errors
with I/O. While certainly an surmountable difficulty, this was always a bit of
a thorn in the side of conditions.
* Functions raising conditions are not always clear that they are raising
conditions. This suffers a similar problem to exceptions where you don't
actually know whether a function raises a condition or not. The documentation
likely explains, but if someone retroactively adds a condition to a function
there's nothing forcing upstream users to acknowledge a new point of task
failure.
* Libaries using I/O are not guaranteed to correctly raise on conditions when an
error occurs. In developing various I/O libraries, it's much easier to just
return `None` from a read rather than raising an error. The silent contract of
"don't raise on EOF" was a little difficult to understand and threw a wrench
into the answer of the question "when do I raise a condition?"
Many of these difficulties can be overcome through documentation, examples, and
general practice. In the end, all of these difficulties added together ended up
being too overwhelming and improving various aspects didn't end up helping that
much.
A result-based I/O error handling strategy also has shortcomings, but the
cognitive burden is much smaller. The tooling necessary to make this strategy as
usable as conditions were is much smaller than the tooling necessary for
conditions.
Perhaps conditions may manifest themselves as a future entity, but for now
we're going to remove them from the standard library.
Closes #9795
Closes #8968
2014-02-04 21:02:10 -06:00
|
|
|
/// Fails the task if the receiver has an interior null.
|
2013-08-03 19:13:14 -05:00
|
|
|
fn to_c_str(&self) -> CString;
|
2013-08-14 21:19:29 -05:00
|
|
|
|
|
|
|
/// Unsafe variant of `to_c_str()` that doesn't check for nulls.
|
|
|
|
unsafe fn to_c_str_unchecked(&self) -> CString;
|
2013-08-14 21:21:59 -05:00
|
|
|
|
|
|
|
/// Work with a temporary CString constructed from the receiver.
|
|
|
|
/// The provided `*libc::c_char` will be freed immediately upon return.
|
|
|
|
///
|
|
|
|
/// # Example
|
|
|
|
///
|
2013-09-23 19:20:36 -05:00
|
|
|
/// ```rust
|
2014-02-26 11:58:41 -06:00
|
|
|
/// extern crate libc;
|
2013-12-22 15:31:23 -06:00
|
|
|
///
|
2014-02-26 11:58:41 -06:00
|
|
|
/// fn main() {
|
|
|
|
/// let s = "PATH".with_c_str(|path| unsafe {
|
|
|
|
/// libc::getenv(path)
|
|
|
|
/// });
|
|
|
|
/// }
|
2013-09-23 19:20:36 -05:00
|
|
|
/// ```
|
2013-08-14 21:21:59 -05:00
|
|
|
///
|
|
|
|
/// # Failure
|
|
|
|
///
|
Remove std::condition
This has been a long time coming. Conditions in rust were initially envisioned
as being a good alternative to error code return pattern. The idea is that all
errors are fatal-by-default, and you can opt-in to handling the error by
registering an error handler.
While sounding nice, conditions ended up having some unforseen shortcomings:
* Actually handling an error has some very awkward syntax:
let mut result = None;
let mut answer = None;
io::io_error::cond.trap(|e| { result = Some(e) }).inside(|| {
answer = Some(some_io_operation());
});
match result {
Some(err) => { /* hit an I/O error */ }
None => {
let answer = answer.unwrap();
/* deal with the result of I/O */
}
}
This pattern can certainly use functions like io::result, but at its core
actually handling conditions is fairly difficult
* The "zero value" of a function is often confusing. One of the main ideas
behind using conditions was to change the signature of I/O functions. Instead
of read_be_u32() returning a result, it returned a u32. Errors were notified
via a condition, and if you caught the condition you understood that the "zero
value" returned is actually a garbage value. These zero values are often
difficult to understand, however.
One case of this is the read_bytes() function. The function takes an integer
length of the amount of bytes to read, and returns an array of that size. The
array may actually be shorter, however, if an error occurred.
Another case is fs::stat(). The theoretical "zero value" is a blank stat
struct, but it's a little awkward to create and return a zero'd out stat
struct on a call to stat().
In general, the return value of functions that can raise error are much more
natural when using a Result as opposed to an always-usable zero-value.
* Conditions impose a necessary runtime requirement on *all* I/O. In theory I/O
is as simple as calling read() and write(), but using conditions imposed the
restriction that a rust local task was required if you wanted to catch errors
with I/O. While certainly an surmountable difficulty, this was always a bit of
a thorn in the side of conditions.
* Functions raising conditions are not always clear that they are raising
conditions. This suffers a similar problem to exceptions where you don't
actually know whether a function raises a condition or not. The documentation
likely explains, but if someone retroactively adds a condition to a function
there's nothing forcing upstream users to acknowledge a new point of task
failure.
* Libaries using I/O are not guaranteed to correctly raise on conditions when an
error occurs. In developing various I/O libraries, it's much easier to just
return `None` from a read rather than raising an error. The silent contract of
"don't raise on EOF" was a little difficult to understand and threw a wrench
into the answer of the question "when do I raise a condition?"
Many of these difficulties can be overcome through documentation, examples, and
general practice. In the end, all of these difficulties added together ended up
being too overwhelming and improving various aspects didn't end up helping that
much.
A result-based I/O error handling strategy also has shortcomings, but the
cognitive burden is much smaller. The tooling necessary to make this strategy as
usable as conditions were is much smaller than the tooling necessary for
conditions.
Perhaps conditions may manifest themselves as a future entity, but for now
we're going to remove them from the standard library.
Closes #9795
Closes #8968
2014-02-04 21:02:10 -06:00
|
|
|
/// Fails the task if the receiver has an interior null.
|
2013-08-14 21:21:59 -05:00
|
|
|
#[inline]
|
2013-11-18 23:15:42 -06:00
|
|
|
fn with_c_str<T>(&self, f: |*libc::c_char| -> T) -> T {
|
2013-08-14 21:21:59 -05:00
|
|
|
self.to_c_str().with_ref(f)
|
|
|
|
}
|
|
|
|
|
|
|
|
/// Unsafe variant of `with_c_str()` that doesn't check for nulls.
|
|
|
|
#[inline]
|
2013-11-18 23:15:42 -06:00
|
|
|
unsafe fn with_c_str_unchecked<T>(&self, f: |*libc::c_char| -> T) -> T {
|
2013-08-14 21:21:59 -05:00
|
|
|
self.to_c_str_unchecked().with_ref(f)
|
|
|
|
}
|
2013-08-03 19:13:14 -05:00
|
|
|
}
|
|
|
|
|
2014-05-05 16:15:11 -05:00
|
|
|
// FIXME (#12938): Until DST lands, we cannot decompose &str into &
|
|
|
|
// and str, so we cannot usefully take ToCStr arguments by reference
|
|
|
|
// (without forcing an additional & around &str). So we are instead
|
2014-05-22 18:57:53 -05:00
|
|
|
// temporarily adding an instance for ~str and String, so that we can
|
2014-05-05 16:15:11 -05:00
|
|
|
// take ToCStr as owned. When DST lands, the string instances should
|
|
|
|
// be revisted, and arguments bound by ToCStr should be passed by
|
|
|
|
// reference.
|
|
|
|
|
2013-12-10 01:16:18 -06:00
|
|
|
impl<'a> ToCStr for &'a str {
|
2013-08-04 20:37:55 -05:00
|
|
|
#[inline]
|
2013-08-03 19:13:14 -05:00
|
|
|
fn to_c_str(&self) -> CString {
|
|
|
|
self.as_bytes().to_c_str()
|
|
|
|
}
|
2013-08-14 21:19:29 -05:00
|
|
|
|
|
|
|
#[inline]
|
|
|
|
unsafe fn to_c_str_unchecked(&self) -> CString {
|
|
|
|
self.as_bytes().to_c_str_unchecked()
|
|
|
|
}
|
2013-09-18 14:32:35 -05:00
|
|
|
|
|
|
|
#[inline]
|
2013-11-18 23:15:42 -06:00
|
|
|
fn with_c_str<T>(&self, f: |*libc::c_char| -> T) -> T {
|
2013-09-18 14:32:35 -05:00
|
|
|
self.as_bytes().with_c_str(f)
|
|
|
|
}
|
2013-09-20 18:48:07 -05:00
|
|
|
|
|
|
|
#[inline]
|
2013-11-18 23:15:42 -06:00
|
|
|
unsafe fn with_c_str_unchecked<T>(&self, f: |*libc::c_char| -> T) -> T {
|
2013-09-20 18:48:07 -05:00
|
|
|
self.as_bytes().with_c_str_unchecked(f)
|
|
|
|
}
|
2013-08-03 19:13:14 -05:00
|
|
|
}
|
|
|
|
|
2014-05-22 18:57:53 -05:00
|
|
|
impl ToCStr for String {
|
2014-05-05 16:15:11 -05:00
|
|
|
#[inline]
|
|
|
|
fn to_c_str(&self) -> CString {
|
|
|
|
self.as_bytes().to_c_str()
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
unsafe fn to_c_str_unchecked(&self) -> CString {
|
|
|
|
self.as_bytes().to_c_str_unchecked()
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
fn with_c_str<T>(&self, f: |*libc::c_char| -> T) -> T {
|
|
|
|
self.as_bytes().with_c_str(f)
|
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
unsafe fn with_c_str_unchecked<T>(&self, f: |*libc::c_char| -> T) -> T {
|
|
|
|
self.as_bytes().with_c_str_unchecked(f)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-09-18 14:32:35 -05:00
|
|
|
// The length of the stack allocated buffer for `vec.with_c_str()`
|
2013-09-20 15:25:02 -05:00
|
|
|
static BUF_LEN: uint = 128;
|
2013-09-18 14:32:35 -05:00
|
|
|
|
2013-12-10 01:16:18 -06:00
|
|
|
impl<'a> ToCStr for &'a [u8] {
|
2013-08-03 19:13:14 -05:00
|
|
|
fn to_c_str(&self) -> CString {
|
2013-08-14 21:19:29 -05:00
|
|
|
let mut cs = unsafe { self.to_c_str_unchecked() };
|
2013-11-20 16:17:12 -06:00
|
|
|
cs.with_mut_ref(|buf| check_for_null(*self, buf));
|
2013-08-14 21:19:29 -05:00
|
|
|
cs
|
|
|
|
}
|
2013-08-03 19:13:14 -05:00
|
|
|
|
2013-08-14 21:19:29 -05:00
|
|
|
unsafe fn to_c_str_unchecked(&self) -> CString {
|
2013-12-17 08:49:31 -06:00
|
|
|
let self_len = self.len();
|
2014-01-27 05:12:59 -06:00
|
|
|
let buf = malloc_raw(self_len + 1);
|
2013-08-14 21:19:29 -05:00
|
|
|
|
2013-12-17 08:49:31 -06:00
|
|
|
ptr::copy_memory(buf, self.as_ptr(), self_len);
|
2014-02-10 15:50:42 -06:00
|
|
|
*buf.offset(self_len as int) = 0;
|
2013-08-14 21:19:29 -05:00
|
|
|
|
2013-12-17 08:49:31 -06:00
|
|
|
CString::new(buf as *libc::c_char, true)
|
2013-08-03 19:13:14 -05:00
|
|
|
}
|
2013-09-18 14:32:35 -05:00
|
|
|
|
2013-11-18 23:15:42 -06:00
|
|
|
fn with_c_str<T>(&self, f: |*libc::c_char| -> T) -> T {
|
2013-09-27 00:49:10 -05:00
|
|
|
unsafe { with_c_str(*self, true, f) }
|
2013-09-18 14:32:35 -05:00
|
|
|
}
|
2013-09-20 18:48:07 -05:00
|
|
|
|
2013-11-18 23:15:42 -06:00
|
|
|
unsafe fn with_c_str_unchecked<T>(&self, f: |*libc::c_char| -> T) -> T {
|
2013-09-27 00:49:10 -05:00
|
|
|
with_c_str(*self, false, f)
|
|
|
|
}
|
|
|
|
}
|
2013-09-20 18:48:07 -05:00
|
|
|
|
2013-09-27 00:49:10 -05:00
|
|
|
// Unsafe function that handles possibly copying the &[u8] into a stack array.
|
2013-11-18 23:15:42 -06:00
|
|
|
unsafe fn with_c_str<T>(v: &[u8], checked: bool, f: |*libc::c_char| -> T) -> T {
|
2013-09-27 00:49:10 -05:00
|
|
|
if v.len() < BUF_LEN {
|
2014-05-23 22:53:56 -05:00
|
|
|
let mut buf: [u8, .. BUF_LEN] = mem::uninitialized();
|
2014-03-08 17:11:52 -06:00
|
|
|
slice::bytes::copy_memory(buf, v);
|
2013-09-27 00:49:10 -05:00
|
|
|
buf[v.len()] = 0;
|
2013-09-20 18:48:07 -05:00
|
|
|
|
2013-12-17 09:13:20 -06:00
|
|
|
let buf = buf.as_mut_ptr();
|
|
|
|
if checked {
|
|
|
|
check_for_null(v, buf as *mut libc::c_char);
|
|
|
|
}
|
2013-09-27 00:49:10 -05:00
|
|
|
|
2013-12-17 09:13:20 -06:00
|
|
|
f(buf as *libc::c_char)
|
2013-09-27 00:49:10 -05:00
|
|
|
} else if checked {
|
|
|
|
v.to_c_str().with_ref(f)
|
|
|
|
} else {
|
|
|
|
v.to_c_str_unchecked().with_ref(f)
|
2013-09-20 18:48:07 -05:00
|
|
|
}
|
2013-09-18 14:32:35 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
#[inline]
|
|
|
|
fn check_for_null(v: &[u8], buf: *mut libc::c_char) {
|
|
|
|
for i in range(0, v.len()) {
|
|
|
|
unsafe {
|
|
|
|
let p = buf.offset(i as int);
|
Remove std::condition
This has been a long time coming. Conditions in rust were initially envisioned
as being a good alternative to error code return pattern. The idea is that all
errors are fatal-by-default, and you can opt-in to handling the error by
registering an error handler.
While sounding nice, conditions ended up having some unforseen shortcomings:
* Actually handling an error has some very awkward syntax:
let mut result = None;
let mut answer = None;
io::io_error::cond.trap(|e| { result = Some(e) }).inside(|| {
answer = Some(some_io_operation());
});
match result {
Some(err) => { /* hit an I/O error */ }
None => {
let answer = answer.unwrap();
/* deal with the result of I/O */
}
}
This pattern can certainly use functions like io::result, but at its core
actually handling conditions is fairly difficult
* The "zero value" of a function is often confusing. One of the main ideas
behind using conditions was to change the signature of I/O functions. Instead
of read_be_u32() returning a result, it returned a u32. Errors were notified
via a condition, and if you caught the condition you understood that the "zero
value" returned is actually a garbage value. These zero values are often
difficult to understand, however.
One case of this is the read_bytes() function. The function takes an integer
length of the amount of bytes to read, and returns an array of that size. The
array may actually be shorter, however, if an error occurred.
Another case is fs::stat(). The theoretical "zero value" is a blank stat
struct, but it's a little awkward to create and return a zero'd out stat
struct on a call to stat().
In general, the return value of functions that can raise error are much more
natural when using a Result as opposed to an always-usable zero-value.
* Conditions impose a necessary runtime requirement on *all* I/O. In theory I/O
is as simple as calling read() and write(), but using conditions imposed the
restriction that a rust local task was required if you wanted to catch errors
with I/O. While certainly an surmountable difficulty, this was always a bit of
a thorn in the side of conditions.
* Functions raising conditions are not always clear that they are raising
conditions. This suffers a similar problem to exceptions where you don't
actually know whether a function raises a condition or not. The documentation
likely explains, but if someone retroactively adds a condition to a function
there's nothing forcing upstream users to acknowledge a new point of task
failure.
* Libaries using I/O are not guaranteed to correctly raise on conditions when an
error occurs. In developing various I/O libraries, it's much easier to just
return `None` from a read rather than raising an error. The silent contract of
"don't raise on EOF" was a little difficult to understand and threw a wrench
into the answer of the question "when do I raise a condition?"
Many of these difficulties can be overcome through documentation, examples, and
general practice. In the end, all of these difficulties added together ended up
being too overwhelming and improving various aspects didn't end up helping that
much.
A result-based I/O error handling strategy also has shortcomings, but the
cognitive burden is much smaller. The tooling necessary to make this strategy as
usable as conditions were is much smaller than the tooling necessary for
conditions.
Perhaps conditions may manifest themselves as a future entity, but for now
we're going to remove them from the standard library.
Closes #9795
Closes #8968
2014-02-04 21:02:10 -06:00
|
|
|
assert!(*p != 0);
|
2013-09-18 14:32:35 -05:00
|
|
|
}
|
|
|
|
}
|
2013-08-03 19:13:14 -05:00
|
|
|
}
|
|
|
|
|
2013-08-04 20:37:55 -05:00
|
|
|
/// External iterator for a CString's bytes.
|
|
|
|
///
|
2013-11-03 17:01:00 -06:00
|
|
|
/// Use with the `std::iter` module.
|
2014-01-14 21:32:24 -06:00
|
|
|
pub struct CChars<'a> {
|
2014-03-27 17:09:47 -05:00
|
|
|
ptr: *libc::c_char,
|
|
|
|
marker: marker::ContravariantLifetime<'a>,
|
2013-08-03 19:13:14 -05:00
|
|
|
}
|
|
|
|
|
2014-01-14 21:32:24 -06:00
|
|
|
impl<'a> Iterator<libc::c_char> for CChars<'a> {
|
2013-08-03 19:13:14 -05:00
|
|
|
fn next(&mut self) -> Option<libc::c_char> {
|
2013-08-06 23:06:12 -05:00
|
|
|
let ch = unsafe { *self.ptr };
|
|
|
|
if ch == 0 {
|
2013-08-03 19:13:14 -05:00
|
|
|
None
|
|
|
|
} else {
|
2014-02-10 15:50:42 -06:00
|
|
|
self.ptr = unsafe { self.ptr.offset(1) };
|
2013-08-03 19:13:14 -05:00
|
|
|
Some(ch)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-10-16 18:48:30 -05:00
|
|
|
/// Parses a C "multistring", eg windows env values or
|
|
|
|
/// the req->ptr result in a uv_fs_readdir() call.
|
|
|
|
///
|
|
|
|
/// Optionally, a `count` can be passed in, limiting the
|
|
|
|
/// parsing to only being done `count`-times.
|
|
|
|
///
|
|
|
|
/// The specified closure is invoked with each string that
|
|
|
|
/// is found, and the number of strings found is returned.
|
|
|
|
pub unsafe fn from_c_multistring(buf: *libc::c_char,
|
|
|
|
count: Option<uint>,
|
2013-11-18 23:15:42 -06:00
|
|
|
f: |&CString|) -> uint {
|
2013-10-16 18:48:30 -05:00
|
|
|
|
|
|
|
let mut curr_ptr: uint = buf as uint;
|
|
|
|
let mut ctr = 0;
|
|
|
|
let (limited_count, limit) = match count {
|
|
|
|
Some(limit) => (true, limit),
|
|
|
|
None => (false, 0)
|
|
|
|
};
|
|
|
|
while ((limited_count && ctr < limit) || !limited_count)
|
|
|
|
&& *(curr_ptr as *libc::c_char) != 0 as libc::c_char {
|
|
|
|
let cstr = CString::new(curr_ptr as *libc::c_char, false);
|
|
|
|
f(&cstr);
|
|
|
|
curr_ptr += cstr.len() + 1;
|
|
|
|
ctr += 1;
|
|
|
|
}
|
|
|
|
return ctr;
|
|
|
|
}
|
|
|
|
|
2013-08-03 19:13:14 -05:00
|
|
|
#[cfg(test)]
|
|
|
|
mod tests {
|
2014-01-07 00:33:37 -06:00
|
|
|
use prelude::*;
|
2013-08-03 19:13:14 -05:00
|
|
|
use super::*;
|
|
|
|
use libc;
|
|
|
|
use ptr;
|
2014-04-15 20:17:48 -05:00
|
|
|
use str::StrSlice;
|
2013-08-03 19:13:14 -05:00
|
|
|
|
2013-10-16 18:48:30 -05:00
|
|
|
#[test]
|
|
|
|
fn test_str_multistring_parsing() {
|
|
|
|
unsafe {
|
|
|
|
let input = bytes!("zero", "\x00", "one", "\x00", "\x00");
|
2013-12-15 06:35:12 -06:00
|
|
|
let ptr = input.as_ptr();
|
2013-10-16 18:48:30 -05:00
|
|
|
let expected = ["zero", "one"];
|
|
|
|
let mut it = expected.iter();
|
2013-11-20 16:17:12 -06:00
|
|
|
let result = from_c_multistring(ptr as *libc::c_char, None, |c| {
|
2014-02-14 17:42:35 -06:00
|
|
|
let cbytes = c.as_bytes_no_nul();
|
2013-10-16 19:05:28 -05:00
|
|
|
assert_eq!(cbytes, it.next().unwrap().as_bytes());
|
2013-11-20 16:17:12 -06:00
|
|
|
});
|
2013-10-16 18:48:30 -05:00
|
|
|
assert_eq!(result, 2);
|
|
|
|
assert!(it.next().is_none());
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2013-08-03 19:13:14 -05:00
|
|
|
#[test]
|
2013-09-15 22:30:03 -05:00
|
|
|
fn test_str_to_c_str() {
|
2013-11-20 16:17:12 -06:00
|
|
|
"".to_c_str().with_ref(|buf| {
|
2013-08-03 19:13:14 -05:00
|
|
|
unsafe {
|
2014-02-10 15:50:42 -06:00
|
|
|
assert_eq!(*buf.offset(0), 0);
|
2013-08-03 19:13:14 -05:00
|
|
|
}
|
2013-11-20 16:17:12 -06:00
|
|
|
});
|
2013-08-03 19:13:14 -05:00
|
|
|
|
2013-11-20 16:17:12 -06:00
|
|
|
"hello".to_c_str().with_ref(|buf| {
|
2013-08-03 19:13:14 -05:00
|
|
|
unsafe {
|
2014-02-10 15:50:42 -06:00
|
|
|
assert_eq!(*buf.offset(0), 'h' as libc::c_char);
|
|
|
|
assert_eq!(*buf.offset(1), 'e' as libc::c_char);
|
|
|
|
assert_eq!(*buf.offset(2), 'l' as libc::c_char);
|
|
|
|
assert_eq!(*buf.offset(3), 'l' as libc::c_char);
|
|
|
|
assert_eq!(*buf.offset(4), 'o' as libc::c_char);
|
|
|
|
assert_eq!(*buf.offset(5), 0);
|
2013-08-03 19:13:14 -05:00
|
|
|
}
|
2013-11-20 16:17:12 -06:00
|
|
|
})
|
2013-08-03 19:13:14 -05:00
|
|
|
}
|
|
|
|
|
2013-09-15 22:30:03 -05:00
|
|
|
#[test]
|
|
|
|
fn test_vec_to_c_str() {
|
|
|
|
let b: &[u8] = [];
|
2013-11-20 16:17:12 -06:00
|
|
|
b.to_c_str().with_ref(|buf| {
|
2013-09-15 22:30:03 -05:00
|
|
|
unsafe {
|
2014-02-10 15:50:42 -06:00
|
|
|
assert_eq!(*buf.offset(0), 0);
|
2013-09-15 22:30:03 -05:00
|
|
|
}
|
2013-11-20 16:17:12 -06:00
|
|
|
});
|
2013-09-15 22:30:03 -05:00
|
|
|
|
2013-11-20 16:17:12 -06:00
|
|
|
let _ = bytes!("hello").to_c_str().with_ref(|buf| {
|
2013-09-15 22:30:03 -05:00
|
|
|
unsafe {
|
2014-02-10 15:50:42 -06:00
|
|
|
assert_eq!(*buf.offset(0), 'h' as libc::c_char);
|
|
|
|
assert_eq!(*buf.offset(1), 'e' as libc::c_char);
|
|
|
|
assert_eq!(*buf.offset(2), 'l' as libc::c_char);
|
|
|
|
assert_eq!(*buf.offset(3), 'l' as libc::c_char);
|
|
|
|
assert_eq!(*buf.offset(4), 'o' as libc::c_char);
|
|
|
|
assert_eq!(*buf.offset(5), 0);
|
2013-09-15 22:30:03 -05:00
|
|
|
}
|
2013-11-20 16:17:12 -06:00
|
|
|
});
|
2013-09-15 22:30:03 -05:00
|
|
|
|
2013-11-20 16:17:12 -06:00
|
|
|
let _ = bytes!("foo", 0xff).to_c_str().with_ref(|buf| {
|
2013-09-15 22:30:03 -05:00
|
|
|
unsafe {
|
2014-02-10 15:50:42 -06:00
|
|
|
assert_eq!(*buf.offset(0), 'f' as libc::c_char);
|
|
|
|
assert_eq!(*buf.offset(1), 'o' as libc::c_char);
|
|
|
|
assert_eq!(*buf.offset(2), 'o' as libc::c_char);
|
|
|
|
assert_eq!(*buf.offset(3), 0xff as i8);
|
|
|
|
assert_eq!(*buf.offset(4), 0);
|
2013-09-15 22:30:03 -05:00
|
|
|
}
|
2013-11-20 16:17:12 -06:00
|
|
|
});
|
2013-09-15 22:30:03 -05:00
|
|
|
}
|
|
|
|
|
2013-08-03 19:13:14 -05:00
|
|
|
#[test]
|
2013-08-04 20:37:55 -05:00
|
|
|
fn test_is_null() {
|
2013-08-06 23:11:10 -05:00
|
|
|
let c_str = unsafe { CString::new(ptr::null(), false) };
|
2013-08-04 20:37:55 -05:00
|
|
|
assert!(c_str.is_null());
|
|
|
|
assert!(!c_str.is_not_null());
|
2013-08-03 19:13:14 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
2013-08-04 20:37:55 -05:00
|
|
|
fn test_unwrap() {
|
|
|
|
let c_str = "hello".to_c_str();
|
2014-01-21 08:31:32 -06:00
|
|
|
unsafe { libc::free(c_str.unwrap() as *mut libc::c_void) }
|
2013-08-03 19:13:14 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
2013-08-04 20:37:55 -05:00
|
|
|
fn test_with_ref() {
|
2013-08-03 19:13:14 -05:00
|
|
|
let c_str = "hello".to_c_str();
|
|
|
|
let len = unsafe { c_str.with_ref(|buf| libc::strlen(buf)) };
|
2013-08-04 20:37:55 -05:00
|
|
|
assert!(!c_str.is_null());
|
|
|
|
assert!(c_str.is_not_null());
|
2013-08-03 19:13:14 -05:00
|
|
|
assert_eq!(len, 5);
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
#[should_fail]
|
2013-08-04 20:37:55 -05:00
|
|
|
fn test_with_ref_empty_fail() {
|
2013-08-06 23:06:12 -05:00
|
|
|
let c_str = unsafe { CString::new(ptr::null(), false) };
|
2013-08-03 19:13:14 -05:00
|
|
|
c_str.with_ref(|_| ());
|
|
|
|
}
|
2013-08-06 23:06:12 -05:00
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_iterator() {
|
|
|
|
let c_str = "".to_c_str();
|
|
|
|
let mut iter = c_str.iter();
|
|
|
|
assert_eq!(iter.next(), None);
|
|
|
|
|
|
|
|
let c_str = "hello".to_c_str();
|
|
|
|
let mut iter = c_str.iter();
|
|
|
|
assert_eq!(iter.next(), Some('h' as libc::c_char));
|
|
|
|
assert_eq!(iter.next(), Some('e' as libc::c_char));
|
|
|
|
assert_eq!(iter.next(), Some('l' as libc::c_char));
|
|
|
|
assert_eq!(iter.next(), Some('l' as libc::c_char));
|
|
|
|
assert_eq!(iter.next(), Some('o' as libc::c_char));
|
|
|
|
assert_eq!(iter.next(), None);
|
|
|
|
}
|
2013-08-14 21:19:29 -05:00
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_to_c_str_fail() {
|
Remove std::condition
This has been a long time coming. Conditions in rust were initially envisioned
as being a good alternative to error code return pattern. The idea is that all
errors are fatal-by-default, and you can opt-in to handling the error by
registering an error handler.
While sounding nice, conditions ended up having some unforseen shortcomings:
* Actually handling an error has some very awkward syntax:
let mut result = None;
let mut answer = None;
io::io_error::cond.trap(|e| { result = Some(e) }).inside(|| {
answer = Some(some_io_operation());
});
match result {
Some(err) => { /* hit an I/O error */ }
None => {
let answer = answer.unwrap();
/* deal with the result of I/O */
}
}
This pattern can certainly use functions like io::result, but at its core
actually handling conditions is fairly difficult
* The "zero value" of a function is often confusing. One of the main ideas
behind using conditions was to change the signature of I/O functions. Instead
of read_be_u32() returning a result, it returned a u32. Errors were notified
via a condition, and if you caught the condition you understood that the "zero
value" returned is actually a garbage value. These zero values are often
difficult to understand, however.
One case of this is the read_bytes() function. The function takes an integer
length of the amount of bytes to read, and returns an array of that size. The
array may actually be shorter, however, if an error occurred.
Another case is fs::stat(). The theoretical "zero value" is a blank stat
struct, but it's a little awkward to create and return a zero'd out stat
struct on a call to stat().
In general, the return value of functions that can raise error are much more
natural when using a Result as opposed to an always-usable zero-value.
* Conditions impose a necessary runtime requirement on *all* I/O. In theory I/O
is as simple as calling read() and write(), but using conditions imposed the
restriction that a rust local task was required if you wanted to catch errors
with I/O. While certainly an surmountable difficulty, this was always a bit of
a thorn in the side of conditions.
* Functions raising conditions are not always clear that they are raising
conditions. This suffers a similar problem to exceptions where you don't
actually know whether a function raises a condition or not. The documentation
likely explains, but if someone retroactively adds a condition to a function
there's nothing forcing upstream users to acknowledge a new point of task
failure.
* Libaries using I/O are not guaranteed to correctly raise on conditions when an
error occurs. In developing various I/O libraries, it's much easier to just
return `None` from a read rather than raising an error. The silent contract of
"don't raise on EOF" was a little difficult to understand and threw a wrench
into the answer of the question "when do I raise a condition?"
Many of these difficulties can be overcome through documentation, examples, and
general practice. In the end, all of these difficulties added together ended up
being too overwhelming and improving various aspects didn't end up helping that
much.
A result-based I/O error handling strategy also has shortcomings, but the
cognitive burden is much smaller. The tooling necessary to make this strategy as
usable as conditions were is much smaller than the tooling necessary for
conditions.
Perhaps conditions may manifest themselves as a future entity, but for now
we're going to remove them from the standard library.
Closes #9795
Closes #8968
2014-02-04 21:02:10 -06:00
|
|
|
use task;
|
|
|
|
assert!(task::try(proc() { "he\x00llo".to_c_str() }).is_err());
|
2013-08-14 21:19:29 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_to_c_str_unchecked() {
|
|
|
|
unsafe {
|
2013-11-20 16:17:12 -06:00
|
|
|
"he\x00llo".to_c_str_unchecked().with_ref(|buf| {
|
2013-08-14 21:19:29 -05:00
|
|
|
assert_eq!(*buf.offset(0), 'h' as libc::c_char);
|
|
|
|
assert_eq!(*buf.offset(1), 'e' as libc::c_char);
|
|
|
|
assert_eq!(*buf.offset(2), 0);
|
|
|
|
assert_eq!(*buf.offset(3), 'l' as libc::c_char);
|
|
|
|
assert_eq!(*buf.offset(4), 'l' as libc::c_char);
|
|
|
|
assert_eq!(*buf.offset(5), 'o' as libc::c_char);
|
|
|
|
assert_eq!(*buf.offset(6), 0);
|
2013-11-20 16:17:12 -06:00
|
|
|
})
|
2013-08-14 21:19:29 -05:00
|
|
|
}
|
|
|
|
}
|
2013-09-15 22:30:03 -05:00
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_as_bytes() {
|
|
|
|
let c_str = "hello".to_c_str();
|
|
|
|
assert_eq!(c_str.as_bytes(), bytes!("hello", 0));
|
|
|
|
let c_str = "".to_c_str();
|
|
|
|
assert_eq!(c_str.as_bytes(), bytes!(0));
|
|
|
|
let c_str = bytes!("foo", 0xff).to_c_str();
|
|
|
|
assert_eq!(c_str.as_bytes(), bytes!("foo", 0xff, 0));
|
|
|
|
}
|
|
|
|
|
2014-02-14 17:42:35 -06:00
|
|
|
#[test]
|
|
|
|
fn test_as_bytes_no_nul() {
|
|
|
|
let c_str = "hello".to_c_str();
|
|
|
|
assert_eq!(c_str.as_bytes_no_nul(), bytes!("hello"));
|
|
|
|
let c_str = "".to_c_str();
|
|
|
|
let exp: &[u8] = [];
|
|
|
|
assert_eq!(c_str.as_bytes_no_nul(), exp);
|
|
|
|
let c_str = bytes!("foo", 0xff).to_c_str();
|
|
|
|
assert_eq!(c_str.as_bytes_no_nul(), bytes!("foo", 0xff));
|
|
|
|
}
|
|
|
|
|
2013-09-15 22:30:03 -05:00
|
|
|
#[test]
|
|
|
|
#[should_fail]
|
|
|
|
fn test_as_bytes_fail() {
|
|
|
|
let c_str = unsafe { CString::new(ptr::null(), false) };
|
|
|
|
c_str.as_bytes();
|
|
|
|
}
|
|
|
|
|
2014-02-14 17:42:35 -06:00
|
|
|
#[test]
|
|
|
|
#[should_fail]
|
|
|
|
fn test_as_bytes_no_nul_fail() {
|
|
|
|
let c_str = unsafe { CString::new(ptr::null(), false) };
|
|
|
|
c_str.as_bytes_no_nul();
|
|
|
|
}
|
|
|
|
|
2013-09-15 22:30:03 -05:00
|
|
|
#[test]
|
|
|
|
fn test_as_str() {
|
|
|
|
let c_str = "hello".to_c_str();
|
|
|
|
assert_eq!(c_str.as_str(), Some("hello"));
|
|
|
|
let c_str = "".to_c_str();
|
|
|
|
assert_eq!(c_str.as_str(), Some(""));
|
|
|
|
let c_str = bytes!("foo", 0xff).to_c_str();
|
|
|
|
assert_eq!(c_str.as_str(), None);
|
2014-01-30 17:29:36 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
#[should_fail]
|
|
|
|
fn test_as_str_fail() {
|
2013-09-15 22:30:03 -05:00
|
|
|
let c_str = unsafe { CString::new(ptr::null(), false) };
|
2014-01-30 17:29:36 -06:00
|
|
|
c_str.as_str();
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
#[should_fail]
|
|
|
|
fn test_len_fail() {
|
|
|
|
let c_str = unsafe { CString::new(ptr::null(), false) };
|
|
|
|
c_str.len();
|
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
#[should_fail]
|
|
|
|
fn test_iter_fail() {
|
|
|
|
let c_str = unsafe { CString::new(ptr::null(), false) };
|
|
|
|
c_str.iter();
|
2013-09-15 22:30:03 -05:00
|
|
|
}
|
2014-01-27 05:12:59 -06:00
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_clone() {
|
2014-01-30 18:10:07 -06:00
|
|
|
let a = "hello".to_c_str();
|
|
|
|
let b = a.clone();
|
|
|
|
assert!(a == b);
|
2014-01-27 05:12:59 -06:00
|
|
|
}
|
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_clone_noleak() {
|
|
|
|
fn foo(f: |c: &CString|) {
|
2014-05-25 05:10:11 -05:00
|
|
|
let s = "test".to_string();
|
2014-01-27 05:12:59 -06:00
|
|
|
let c = s.to_c_str();
|
|
|
|
// give the closure a non-owned CString
|
|
|
|
let mut c_ = c.with_ref(|c| unsafe { CString::new(c, false) } );
|
|
|
|
f(&c_);
|
|
|
|
// muck with the buffer for later printing
|
|
|
|
c_.with_mut_ref(|c| unsafe { *c = 'X' as libc::c_char } );
|
|
|
|
}
|
|
|
|
|
|
|
|
let mut c_: Option<CString> = None;
|
|
|
|
foo(|c| {
|
|
|
|
c_ = Some(c.clone());
|
|
|
|
c.clone();
|
|
|
|
// force a copy, reading the memory
|
|
|
|
c.as_bytes().to_owned();
|
|
|
|
});
|
|
|
|
let c_ = c_.unwrap();
|
|
|
|
// force a copy, reading the memory
|
|
|
|
c_.as_bytes().to_owned();
|
|
|
|
}
|
2014-01-30 18:10:07 -06:00
|
|
|
|
|
|
|
#[test]
|
|
|
|
fn test_clone_eq_null() {
|
|
|
|
let x = unsafe { CString::new(ptr::null(), false) };
|
|
|
|
let y = x.clone();
|
|
|
|
assert!(x == y);
|
|
|
|
}
|
2013-08-03 19:13:14 -05:00
|
|
|
}
|
2013-09-18 14:32:45 -05:00
|
|
|
|
|
|
|
#[cfg(test)]
|
|
|
|
mod bench {
|
2014-02-13 19:49:11 -06:00
|
|
|
extern crate test;
|
2014-03-31 20:16:35 -05:00
|
|
|
use self::test::Bencher;
|
2013-09-18 14:32:45 -05:00
|
|
|
use libc;
|
2014-01-07 00:33:37 -06:00
|
|
|
use prelude::*;
|
2013-09-18 14:32:45 -05:00
|
|
|
|
|
|
|
#[inline]
|
|
|
|
fn check(s: &str, c_str: *libc::c_char) {
|
2013-12-17 09:37:30 -06:00
|
|
|
let s_buf = s.as_ptr();
|
|
|
|
for i in range(0, s.len()) {
|
|
|
|
unsafe {
|
|
|
|
assert_eq!(
|
2014-02-10 15:50:42 -06:00
|
|
|
*s_buf.offset(i as int) as libc::c_char,
|
|
|
|
*c_str.offset(i as int));
|
2013-09-18 14:32:45 -05:00
|
|
|
}
|
2013-12-17 09:37:30 -06:00
|
|
|
}
|
2013-09-18 14:32:45 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
static s_short: &'static str = "Mary";
|
|
|
|
static s_medium: &'static str = "Mary had a little lamb";
|
|
|
|
static s_long: &'static str = "\
|
|
|
|
Mary had a little lamb, Little lamb
|
|
|
|
Mary had a little lamb, Little lamb
|
|
|
|
Mary had a little lamb, Little lamb
|
|
|
|
Mary had a little lamb, Little lamb
|
|
|
|
Mary had a little lamb, Little lamb
|
|
|
|
Mary had a little lamb, Little lamb";
|
|
|
|
|
2014-03-31 20:16:35 -05:00
|
|
|
fn bench_to_str(b: &mut Bencher, s: &str) {
|
|
|
|
b.iter(|| {
|
2013-09-18 14:32:45 -05:00
|
|
|
let c_str = s.to_c_str();
|
2013-11-20 16:17:12 -06:00
|
|
|
c_str.with_ref(|c_str_buf| check(s, c_str_buf))
|
|
|
|
})
|
2013-09-18 14:32:45 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
#[bench]
|
2014-03-31 20:16:35 -05:00
|
|
|
fn bench_to_c_str_short(b: &mut Bencher) {
|
|
|
|
bench_to_str(b, s_short)
|
2013-09-18 14:32:45 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
#[bench]
|
2014-03-31 20:16:35 -05:00
|
|
|
fn bench_to_c_str_medium(b: &mut Bencher) {
|
|
|
|
bench_to_str(b, s_medium)
|
2013-09-18 14:32:45 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
#[bench]
|
2014-03-31 20:16:35 -05:00
|
|
|
fn bench_to_c_str_long(b: &mut Bencher) {
|
|
|
|
bench_to_str(b, s_long)
|
2013-09-18 14:32:45 -05:00
|
|
|
}
|
|
|
|
|
2014-03-31 20:16:35 -05:00
|
|
|
fn bench_to_c_str_unchecked(b: &mut Bencher, s: &str) {
|
|
|
|
b.iter(|| {
|
2013-09-18 14:32:45 -05:00
|
|
|
let c_str = unsafe { s.to_c_str_unchecked() };
|
2013-11-20 16:17:12 -06:00
|
|
|
c_str.with_ref(|c_str_buf| check(s, c_str_buf))
|
|
|
|
})
|
2013-09-18 14:32:45 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
#[bench]
|
2014-03-31 20:16:35 -05:00
|
|
|
fn bench_to_c_str_unchecked_short(b: &mut Bencher) {
|
|
|
|
bench_to_c_str_unchecked(b, s_short)
|
2013-09-18 14:32:45 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
#[bench]
|
2014-03-31 20:16:35 -05:00
|
|
|
fn bench_to_c_str_unchecked_medium(b: &mut Bencher) {
|
|
|
|
bench_to_c_str_unchecked(b, s_medium)
|
2013-09-18 14:32:45 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
#[bench]
|
2014-03-31 20:16:35 -05:00
|
|
|
fn bench_to_c_str_unchecked_long(b: &mut Bencher) {
|
|
|
|
bench_to_c_str_unchecked(b, s_long)
|
2013-09-18 14:32:45 -05:00
|
|
|
}
|
|
|
|
|
2014-03-31 20:16:35 -05:00
|
|
|
fn bench_with_c_str(b: &mut Bencher, s: &str) {
|
|
|
|
b.iter(|| {
|
2013-11-20 16:17:12 -06:00
|
|
|
s.with_c_str(|c_str_buf| check(s, c_str_buf))
|
|
|
|
})
|
2013-09-18 14:32:45 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
#[bench]
|
2014-03-31 20:16:35 -05:00
|
|
|
fn bench_with_c_str_short(b: &mut Bencher) {
|
|
|
|
bench_with_c_str(b, s_short)
|
2013-09-18 14:32:45 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
#[bench]
|
2014-03-31 20:16:35 -05:00
|
|
|
fn bench_with_c_str_medium(b: &mut Bencher) {
|
|
|
|
bench_with_c_str(b, s_medium)
|
2013-09-18 14:32:45 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
#[bench]
|
2014-03-31 20:16:35 -05:00
|
|
|
fn bench_with_c_str_long(b: &mut Bencher) {
|
|
|
|
bench_with_c_str(b, s_long)
|
2013-09-18 14:32:45 -05:00
|
|
|
}
|
2013-09-20 18:48:07 -05:00
|
|
|
|
2014-03-31 20:16:35 -05:00
|
|
|
fn bench_with_c_str_unchecked(b: &mut Bencher, s: &str) {
|
|
|
|
b.iter(|| {
|
2013-09-20 18:48:07 -05:00
|
|
|
unsafe {
|
2013-11-20 16:17:12 -06:00
|
|
|
s.with_c_str_unchecked(|c_str_buf| check(s, c_str_buf))
|
2013-09-20 18:48:07 -05:00
|
|
|
}
|
2013-11-20 16:17:12 -06:00
|
|
|
})
|
2013-09-20 18:48:07 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
#[bench]
|
2014-03-31 20:16:35 -05:00
|
|
|
fn bench_with_c_str_unchecked_short(b: &mut Bencher) {
|
|
|
|
bench_with_c_str_unchecked(b, s_short)
|
2013-09-20 18:48:07 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
#[bench]
|
2014-03-31 20:16:35 -05:00
|
|
|
fn bench_with_c_str_unchecked_medium(b: &mut Bencher) {
|
|
|
|
bench_with_c_str_unchecked(b, s_medium)
|
2013-09-20 18:48:07 -05:00
|
|
|
}
|
|
|
|
|
|
|
|
#[bench]
|
2014-03-31 20:16:35 -05:00
|
|
|
fn bench_with_c_str_unchecked_long(b: &mut Bencher) {
|
|
|
|
bench_with_c_str_unchecked(b, s_long)
|
2013-09-20 18:48:07 -05:00
|
|
|
}
|
2013-09-18 14:32:45 -05:00
|
|
|
}
|