Enum voodoo::util::CharStr
[−]
[src]
pub enum CharStr<'cp> { CString(CString), CStr(&'cp CStr), }
An owned or borrowed C string representable as a pointer.
Variants
CString(CString)
CStr(&'cp CStr)
Methods from Deref<Target = CStr>
fn as_ptr(&self) -> *const i8
1.0.0[src]
Returns the inner pointer to this C string.
The returned pointer will be valid for as long as self
is and points
to a contiguous region of memory terminated with a 0 byte to represent
the end of the string.
WARNING
It is your responsibility to make sure that the underlying memory is not
freed too early. For example, the following code will cause undefined
behavior when ptr
is used inside the unsafe
block:
use std::ffi::{CString}; let ptr = CString::new("Hello").unwrap().as_ptr(); unsafe { // `ptr` is dangling *ptr; }
This happens because the pointer returned by as_ptr
does not carry any
lifetime information and the string is deallocated immediately after
the CString::new("Hello").unwrap().as_ptr()
expression is evaluated.
To fix the problem, bind the string to a local variable:
use std::ffi::{CString}; let hello = CString::new("Hello").unwrap(); let ptr = hello.as_ptr(); unsafe { // `ptr` is valid because `hello` is in scope *ptr; }
fn to_bytes(&self) -> &[u8]
1.0.0[src]
Converts this C string to a byte slice.
This function will calculate the length of this string (which normally
requires a linear amount of work to be done) and then return the
resulting slice of u8
elements.
The returned slice will not contain the trailing nul that this C string has.
Note: This method is currently implemented as a 0-cost cast, but it is planned to alter its definition in the future to perform the length calculation whenever this method is called.
Examples
use std::ffi::CStr; let c_str = CStr::from_bytes_with_nul(b"foo\0").unwrap(); assert_eq!(c_str.to_bytes(), b"foo");
fn to_bytes_with_nul(&self) -> &[u8]
1.0.0[src]
Converts this C string to a byte slice containing the trailing 0 byte.
This function is the equivalent of to_bytes
except that it will retain
the trailing nul instead of chopping it off.
Note: This method is currently implemented as a 0-cost cast, but it is planned to alter its definition in the future to perform the length calculation whenever this method is called.
Examples
use std::ffi::CStr; let c_str = CStr::from_bytes_with_nul(b"foo\0").unwrap(); assert_eq!(c_str.to_bytes_with_nul(), b"foo\0");
fn to_str(&self) -> Result<&str, Utf8Error>
1.4.0[src]
Yields a &str
slice if the CStr
contains valid UTF-8.
This function will calculate the length of this string and check for
UTF-8 validity, and then return the &str
if it's valid.
Note: This method is currently implemented to check for validity after a 0-cost cast, but it is planned to alter its definition in the future to perform the length calculation in addition to the UTF-8 check whenever this method is called.
Examples
use std::ffi::CStr; let c_str = CStr::from_bytes_with_nul(b"foo\0").unwrap(); assert_eq!(c_str.to_str(), Ok("foo"));
fn to_string_lossy(&self) -> Cow<str>
1.4.0[src]
Converts a CStr
into a Cow
<
str
>
.
This function will calculate the length of this string (which normally
requires a linear amount of work to be done) and then return the
resulting slice as a Cow
<
str
>
, replacing any invalid UTF-8 sequences
with U+FFFD REPLACEMENT CHARACTER
.
Note: This method is currently implemented to check for validity after a 0-cost cast, but it is planned to alter its definition in the future to perform the length calculation in addition to the UTF-8 check whenever this method is called.
Examples
Calling to_string_lossy
on a CStr
containing valid UTF-8:
use std::borrow::Cow; use std::ffi::CStr; let c_str = CStr::from_bytes_with_nul(b"Hello World\0").unwrap(); assert_eq!(c_str.to_string_lossy(), Cow::Borrowed("Hello World"));
Calling to_string_lossy
on a CStr
containing invalid UTF-8:
use std::borrow::Cow; use std::ffi::CStr; let c_str = CStr::from_bytes_with_nul(b"Hello \xF0\x90\x80World\0").unwrap(); assert_eq!( c_str.to_string_lossy(), Cow::Owned(String::from("Hello �World")) as Cow<str> );
Trait Implementations
impl<'cp> Debug for CharStr<'cp>
[src]
impl<'cp> Clone for CharStr<'cp>
[src]
fn clone(&self) -> CharStr<'cp>
[src]
Returns a copy of the value. Read more
fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl<'cp> Deref for CharStr<'cp>
[src]
type Target = CStr
The resulting type after dereferencing.
fn deref(&self) -> &CStr
[src]
Dereferences the value.
impl<'cp, 's> From<&'s CStr> for CharStr<'cp> where
's: 'cp,
[src]
's: 'cp,
impl<'cp, 's> From<&'s [u8]> for CharStr<'cp> where
's: 'cp,
[src]
's: 'cp,
impl<'cp> From<CString> for CharStr<'cp>
[src]
impl<'cp, 's> From<&'s str> for CharStr<'cp> where
's: 'cp,
[src]
's: 'cp,