Struct CStr

pub struct CStr<'a> { /* private fields */ }

Struct representing a C string.

Implementations

impl<'a> CStr<'a>

pub fn from_bytes_with_nul(bytes: &'static [u8]) -> Result<Self, CStrError>

Creates a new CStr instance from a static byte slice that is null-terminated.

Arguments

• bytes - A static byte slice that must be null-terminated.

Returns

A new CStr instance representing the input byte slice.

Errors

This method will return a CStrError if the input bytes slice does not have a null terminator.

pub fn from_ptr(ptr: NonNull<i8>) -> Self

Creates a new CStr instance from a NonNull<i8> raw pointer.

Arguments

• ptr - A NonNull<i8> raw pointer to the null-terminated C-style string.

Returns

A new CStr instance representing the input pointer.

pub fn len(self) -> usize

Calculates the length of the C-style string represented by the CStr instance.

Returns

The length of the C-style string, not including the null terminator.

pub fn is_empty(self) -> bool

Checks if the C-style string represented by the CStr instance is empty.

Returns

true if the C-style string is empty, false otherwise.

pub fn to_bytes(self) -> &'a [u8]

Retrieves a reference to the underlying byte slice of the CStr instance.

Returns

A borrowed reference to the byte slice represented by the CStr instance.

Trait Implementations

impl<'a> Clone for CStr<'a>

fn clone(&self) -> CStr<'a>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CStr<'_>

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for CStr<'_>

fn fmt(&self, formatter: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'a> Copy for CStr<'a>

impl Send for CStr<'_>

impl Sync for CStr<'_>