Struct pelite::util::CStr

pub struct CStr { /* fields omitted */ }

Nul-terminated C string.

Methods

impl CStr

pub fn empty() -> &'static CStr

Returns the empty nul-terminated C string.

pub fn from_bytes(bytes: &[u8]) -> Option<&CStr>

Scans the byte slice for a nul-terminated C string.

Returns None if no nul byte was found.

Examples

use pelite::util::CStr;

let c_str = CStr::from_bytes(b"Hello\0World\0").unwrap();
assert_eq!(c_str.to_str(), Ok("Hello"));
assert_eq!(c_str.c_str(), b"Hello\0");
assert_eq!(c_str.len(), 5);

let no_nul = CStr::from_bytes(b"not nul terminated");
assert_eq!(no_nul, None);

pub unsafe fn from_bytes_unchecked(bytes: &[u8]) -> &CStr

Interprets a byte slice as a C string.

Safety

Ensure that the byte slice ends with the only nul byte.

pub fn c_str(&self) -> &[u8]

Gets the C string as a nul terminated byte slice.

pub fn to_str(&self) -> Result<&str, Utf8Error>

Casts the C string to an UTF8 validated str.

Trait Implementations

impl FromBytes for CStr

const MIN_SIZE_OF: usize

Minimum size argument.

const ALIGN_OF: usize

Alignment argument.

unsafe fn from_bytes(bytes: &[u8]) -> Option<&CStr>

Converts from a byte slice to a string.

impl AsRef<[u8]> for CStr

fn as_ref(&self) -> &[u8]

Performs the conversion.

impl Eq for CStr

impl<T: AsRef<[u8]> + ?Sized> PartialOrd<T> for CStr

fn partial_cmp(&self, rhs: &T) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl<T: AsRef<[u8]> + ?Sized> PartialEq<T> for CStr

fn eq(&self, rhs: &T) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Ord for CStr

fn cmp(&self, other: &CStr) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

🔬 This is a nightly-only experimental API. (clamp)

Restrict a value to a certain interval.

impl Hash for CStr

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl Deref for CStr

type Target = [u8]

The resulting type after dereferencing.

fn deref(&self) -> &[u8]

Dereferences the value.

impl Debug for CStr

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Display for CStr

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Serialize for CStr

fn serialize<S: Serializer>(&self, serializer: S) -> Result<S::Ok, S::Error>

Serialize this value into the given Serde serializer.