Add as_c_str method on strings

This commit is contained in:
Ben Striegel
2013-05-31 18:11:38 -04:00
parent 91a7073900
commit c77d58fad8
2 changed files with 40 additions and 23 deletions

View File

@@ -45,7 +45,7 @@ pub use path::PosixPath;
pub use path::WindowsPath; pub use path::WindowsPath;
pub use ptr::Ptr; pub use ptr::Ptr;
pub use ascii::{Ascii, AsciiCast, OwnedAsciiCast, AsciiStr}; pub use ascii::{Ascii, AsciiCast, OwnedAsciiCast, AsciiStr};
pub use str::{StrSlice, OwnedStr}; pub use str::{StrSlice, OwnedStr, StrUtil};
pub use from_str::{FromStr}; pub use from_str::{FromStr};
pub use to_bytes::IterBytes; pub use to_bytes::IterBytes;
pub use to_str::{ToStr, ToStrConsume}; pub use to_str::{ToStr, ToStrConsume};

View File

@@ -2165,33 +2165,50 @@ pub fn as_bytes_slice<'a>(s: &'a str) -> &'a [u8] {
} }
/** /**
* Work with the byte buffer of a string as a null-terminated C string. * A dummy trait to hold all the utility methods that we implement on strings.
*
* Allows for unsafe manipulation of strings, which is useful for foreign
* interop. This is similar to `str::as_buf`, but guarantees null-termination.
* If the given slice is not already null-terminated, this function will
* allocate a temporary, copy the slice, null terminate it, and pass
* that instead.
*
* # Example
*
* ~~~ {.rust}
* let s = str::as_c_str("PATH", { |path| libc::getenv(path) });
* ~~~
*/ */
#[inline] pub trait StrUtil {
pub fn as_c_str<T>(s: &str, f: &fn(*libc::c_char) -> T) -> T { /**
do as_buf(s) |buf, len| { * Work with the byte buffer of a string as a null-terminated C string.
// NB: len includes the trailing null. *
assert!(len > 0); * Allows for unsafe manipulation of strings, which is useful for foreign
if unsafe { *(ptr::offset(buf,len-1)) != 0 } { * interop. This is similar to `str::as_buf`, but guarantees null-termination.
as_c_str(to_owned(s), f) * If the given slice is not already null-terminated, this function will
} else { * allocate a temporary, copy the slice, null terminate it, and pass
f(buf as *libc::c_char) * that instead.
*
* # Example
*
* ~~~ {.rust}
* let s = "PATH".as_c_str(|path| libc::getenv(path));
* ~~~
*/
fn as_c_str<T>(self, f: &fn(*libc::c_char) -> T) -> T;
}
impl<'self> StrUtil for &'self str {
#[inline]
fn as_c_str<T>(self, f: &fn(*libc::c_char) -> T) -> T {
do as_buf(self) |buf, len| {
// NB: len includes the trailing null.
assert!(len > 0);
if unsafe { *(ptr::offset(buf,len-1)) != 0 } {
to_owned(self).as_c_str(f)
} else {
f(buf as *libc::c_char)
}
} }
} }
} }
/**
* Deprecated. Use the `as_c_str` method on strings instead.
*/
#[inline(always)]
pub fn as_c_str<T>(s: &str, f: &fn(*libc::c_char) -> T) -> T {
s.as_c_str(f)
}
/** /**
* Work with the byte buffer and length of a slice. * Work with the byte buffer and length of a slice.
* *