Struct CStrPtr 

pub struct CStrPtr(/* private fields */);

A pointer to a NUL-terminated narrow string (char*), possibly null.

Reading it is unsafe: the pointer comes from the target and can’t be checked. A null pointer reads as an empty string.

Examples

use imping_runtime::CStrPtr;

let greeting = CStrPtr::from(c"hello");
// SAFETY: `greeting` points to a static, NUL-terminated string.
assert_eq!(unsafe { greeting.to_string_lossy() }, "hello");
assert_eq!(unsafe { CStrPtr::null().to_string_lossy() }, "");

Implementations

impl CStrPtr

pub const fn new(ptr: *const c_char) -> Self

Wraps a raw pointer.

pub const fn null() -> Self

Returns a null pointer.

pub fn is_null(self) -> bool

Returns whether the pointer is null.

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

Returns the raw pointer.

pub const fn as_mut_ptr(self) -> *mut c_char

Returns the raw pointer as *mut, for functions that write through it.

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

Returns the string’s bytes without the terminating NUL, or an empty slice if the pointer is null.

As with CStr::from_ptr, the caller chooses the lifetime 'a.

Safety

A non-null pointer must point to a NUL-terminated string that stays valid and unchanged for 'a.

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

Returns the string as UTF-8.

Errors

If the bytes are not valid UTF-8.

Safety

A non-null pointer must point to a NUL-terminated string that stays valid and unchanged for 'a.

pub unsafe fn to_string_lossy<'a>(self) -> Cow<'a, str>

Returns the string as UTF-8, with invalid sequences replaced by �.

Safety

A non-null pointer must point to a NUL-terminated string that stays valid and unchanged for 'a.

pub unsafe fn to_string_ansi(self) -> String

Decodes the string with the system’s ANSI code page, as Windows “A” functions do.

On other platforms, the same as to_string_lossy.

Safety

A non-null pointer must point to a NUL-terminated string that stays valid and unchanged during the call.

Trait Implementations

impl Clone for CStrPtr

fn clone(&self) -> CStrPtr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for CStrPtr

impl Debug for CStrPtr

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

Formats the value using the given formatter.

impl Default for CStrPtr

fn default() -> Self

Returns a null pointer.

impl Eq for CStrPtr

impl From<&'static CStr> for CStrPtr

fn from(value: &'static CStr) -> Self

Points to a static C string, such as a c"…" literal.

impl Hash for CStrPtr

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, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for CStrPtr

fn eq(&self, other: &CStrPtr) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Plain for CStrPtr

impl StructuralPartialEq for CStrPtr