Struct PSTR

pub struct PSTR { /* private fields */ }

A type representing an owned, C-compatible, nul-terminated string with no nul bytes in the middle.

This type serves the purpose of being able to safely generate a C-compatible string from a Rust byte slice or vector. An instance of this type is a static guarantee that the underlying bytes contain no interior 0 bytes (“nul characters”) and that the final byte is 0 (“nul terminator”).

CString is to &CStr as String is to &str: the former in each pair are owned strings; the latter are borrowed references.

Implementations

impl PSTR

pub fn to_string(&self) -> Result<String, StringError>

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.

pub fn as_ptr(&self) -> *const c_char

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.

The type of the returned pointer is *const c_char, and whether it’s an alias for *const i8 or *const u8 is platform-specific.

WARNING

The returned pointer is read-only; writing to it (including passing it to C code that writes to it) causes undefined behavior.

pub fn strcpy(src: &str, dest: *mut c_char)

Copy the string pointed to by src to dest.

The behavior of this function is essentially the same as the behavior of strcpy in the C standard library.

Trait Implementations

impl Drop for PSTR

fn drop(&mut self)

Executes the destructor for this type.

impl From<&str> for PSTR

fn from(value: &str) -> Self

Converts to this type from the input type.

impl From<*const i8> for PSTR

fn from(ptr: *const c_char) -> Self

Converts to this type from the input type.

impl From<String> for PSTR

fn from(value: String) -> Self

Converts to this type from the input type.