Struct internship::ICStr
[−]
[src]
pub struct ICStr(_);
Methods
impl ICStr
[src]
pub fn new(src: &CStr) -> Self
[src]
pub fn from_bytes_with_nul(src: &[u8]) -> Result<Self, FromBytesWithNulError>
[src]
pub fn as_cstr(&self) -> &CStr
[src]
pub fn as_bytes(&self) -> &[u8]
[src]
result slice does not contains trailing nul terminator.
pub fn as_bytes_with_nul(&self) -> &[u8]
[src]
pub fn to_ibytes_with_nul(&self) -> IBytes
[src]
pub fn to_istr(&self) -> Result<IStr, Utf8Error>
[src]
Methods from Deref<Target = CStr>
pub 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 CString
is deallocated immediately after
the CString::new("Hello").unwrap().as_ptr()
expression is evaluated.
To fix the problem, bind the CString
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; }
This way, the lifetime of the CString
in hello
encompasses
the lifetime of ptr
and the unsafe
block.
pub fn to_bytes(&self) -> &[u8]
1.0.0[src]
Converts this C string to a byte slice.
The returned slice will not contain the trailing nul terminator that this C string has.
Note: This method is currently implemented as a constant-time 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");
pub 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 terminator 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");
pub fn to_str(&self) -> Result<&str, Utf8Error>
1.4.0[src]
Yields a &str
slice if the CStr
contains valid UTF-8.
If the contents of the CStr
are valid UTF-8 data, this
function will return the corresponding &str
slice. Otherwise,
it will return an error with details of where UTF-8 validation failed.
Note: This method is currently implemented to check for validity after a constant-time 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"));
pub fn to_string_lossy(&self) -> Cow<str>
1.4.0[src]
Converts a CStr
into a Cow
<
str
>
.
If the contents of the CStr
are valid UTF-8 data, this
function will return a Cow
::
Borrowed
(
[&str
])
with the the corresponding [&str
] slice. Otherwise, it will
replace any invalid UTF-8 sequences with U+FFFD REPLACEMENT CHARACTER
and return a Cow
::
[Owned
](
String
)
with the result.
Note: This method is currently implemented to check for validity after a constant-time 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 From<ICStr> for IBytes
[src]
impl Clone for ICStr
[src]
fn clone(&self) -> ICStr
[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 PartialEq for ICStr
[src]
fn eq(&self, __arg_0: &ICStr) -> bool
[src]
This method tests for self
and other
values to be equal, and is used by ==
. Read more
fn ne(&self, __arg_0: &ICStr) -> bool
[src]
This method tests for !=
.
impl Eq for ICStr
[src]
impl PartialOrd for ICStr
[src]
fn partial_cmp(&self, __arg_0: &ICStr) -> Option<Ordering>
[src]
This method returns an ordering between self
and other
values if one exists. Read more
fn lt(&self, __arg_0: &ICStr) -> bool
[src]
This method tests less than (for self
and other
) and is used by the <
operator. Read more
fn le(&self, __arg_0: &ICStr) -> bool
[src]
This method tests less than or equal to (for self
and other
) and is used by the <=
operator. Read more
fn gt(&self, __arg_0: &ICStr) -> bool
[src]
This method tests greater than (for self
and other
) and is used by the >
operator. Read more
fn ge(&self, __arg_0: &ICStr) -> bool
[src]
This method tests greater than or equal to (for self
and other
) and is used by the >=
operator. Read more
impl Ord for ICStr
[src]
fn cmp(&self, __arg_0: &ICStr) -> Ordering
[src]
This method returns an Ordering
between self
and other
. Read more
fn max(self, other: Self) -> Self
1.21.0[src]
Compares and returns the maximum of two values. Read more
fn min(self, other: Self) -> Self
1.21.0[src]
Compares and returns the minimum of two values. Read more
impl Deref for ICStr
[src]
type Target = CStr
The resulting type after dereferencing.
fn deref(&self) -> &CStr
[src]
Dereferences the value.
impl From<CString> for ICStr
[src]
impl<'a> From<&'a CStr> for ICStr
[src]
impl From<Box<CStr>> for ICStr
[src]
impl Default for ICStr
[src]
impl Hash for ICStr
[src]
fn hash<H: Hasher>(&self, hasher: &mut H)
[src]
Feeds this value into the given [Hasher
]. Read more
fn hash_slice<H>(data: &[Self], state: &mut H) where
H: Hasher,
1.3.0[src]
H: Hasher,
Feeds a slice of this type into the given [Hasher
]. Read more
impl Borrow<CStr> for ICStr
[src]
impl Index<RangeFull> for ICStr
[src]
type Output = CStr
The returned type after indexing.
fn index(&self, _index: RangeFull) -> &CStr
[src]
Performs the indexing (container[index]
) operation.