[−][src]Struct c_lexer::internship::ICStr
Methods
impl ICStr
[src]
pub fn new(src: &CStr) -> ICStr
[src]
pub fn from_bytes_with_nul(src: &[u8]) -> Result<ICStr, 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 const 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").expect("CString::new failed").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").expect("CString::new failed").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").expect("CString::new failed"); 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").expect("CStr::from_bytes_with_nul failed"); 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").expect("CStr::from_bytes_with_nul failed"); 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").expect("CStr::from_bytes_with_nul failed"); 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 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") .expect("CStr::from_bytes_with_nul failed"); 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") .expect("CStr::from_bytes_with_nul failed"); assert_eq!( c_str.to_string_lossy(), Cow::Owned(String::from("Hello �World")) as Cow<'_, str> );
Trait Implementations
impl Hash for ICStr
[src]
fn hash<H>(&self, hasher: &mut H) where
H: Hasher,
[src]
H: Hasher,
default 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 Ord for ICStr
[src]
fn cmp(&self, other: &ICStr) -> Ordering
[src]
default fn max(self, other: Self) -> Self
1.21.0[src]
Compares and returns the maximum of two values. Read more
default fn min(self, other: Self) -> Self
1.21.0[src]
Compares and returns the minimum of two values. Read more
default fn clamp(self, min: Self, max: Self) -> Self
[src]
clamp
)Restrict a value to a certain interval. Read more
impl Index<RangeFull> for ICStr
[src]
type Output = CStr
The returned type after indexing.
fn index(&self, _index: RangeFull) -> &CStr
[src]
impl Clone for ICStr
[src]
fn clone(&self) -> ICStr
[src]
default fn clone_from(&mut self, source: &Self)
1.0.0[src]
Performs copy-assignment from source
. Read more
impl AsRef<CStr> for ICStr
[src]
impl Eq for ICStr
[src]
impl PartialOrd<ICStr> for ICStr
[src]
fn partial_cmp(&self, other: &ICStr) -> Option<Ordering>
[src]
fn lt(&self, other: &ICStr) -> bool
[src]
fn le(&self, other: &ICStr) -> bool
[src]
fn gt(&self, other: &ICStr) -> bool
[src]
fn ge(&self, other: &ICStr) -> bool
[src]
impl<'a> From<&'a CStr> for ICStr
[src]
impl From<CString> for ICStr
[src]
impl From<Box<CStr>> for ICStr
[src]
impl From<ICStr> for IBytes
[src]
impl Borrow<CStr> for ICStr
[src]
impl Deref for ICStr
[src]
impl PartialEq<ICStr> for ICStr
[src]
impl Default for ICStr
[src]
Auto Trait Implementations
Blanket Implementations
impl<T> ToOwned for T where
T: Clone,
[src]
T: Clone,
impl<T, U> Into for T where
U: From<T>,
[src]
U: From<T>,
impl<T> From for T
[src]
impl<T, U> TryFrom for T where
U: Into<T>,
[src]
U: Into<T>,
type Error = Infallible
The type returned in the event of a conversion error.
fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>
[src]
impl<T> Borrow for T where
T: ?Sized,
[src]
T: ?Sized,
impl<T> Any for T where
T: 'static + ?Sized,
[src]
T: 'static + ?Sized,
impl<T> BorrowMut for T where
T: ?Sized,
[src]
T: ?Sized,
fn borrow_mut(&mut self) -> &mut T
[src]
impl<T, U> TryInto for T where
U: TryFrom<T>,
[src]
U: TryFrom<T>,