Struct zombiezen_const_cstr::ConstCStr

pub struct ConstCStr { /* fields omitted */ }

A reference to a C-compatible string constant.

Implementations

impl ConstCStr

pub const unsafe fn from_str_with_nul_unchecked(val: &'static str) -> ConstCStr

Unsafely creates a constant C string reference from a string slice.

Prefer using the const_cstr! macro than calling this function directly.

Safety

The provided slice must be NUL-terminated and not contain any interior NUL bytes.

Examples

use zombiezen_const_cstr::ConstCStr;

let s = unsafe { ConstCStr::from_str_with_nul_unchecked("foo\0") };
assert_eq!(s.as_str(), "foo");

pub fn as_str(self) -> &'static str

Returns the referenced string without the terminating NUL byte.

pub fn as_bytes(self) -> &'static [u8]

Returns the referenced string as a byte slice without the terminating NUL byte.

pub const fn as_bytes_with_nul(self) -> &'static [u8]

Returns the referenced string as a byte slice, with the NUL terminating byte.

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

Returns a pointer to the beginning of the string constant.

Suitable for passing to any function that expects a C-compatible string. Since the underlying string is guaranteed to be 'static, the pointer should always be valid.

pub fn as_cstr(self) -> &'static CStr

Returns &'static CStr to the referenced string.

Trait Implementations

impl AsRef<[u8]> for ConstCStr

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

Performs the conversion.

impl AsRef<CStr> for ConstCStr

fn as_ref(&self) -> &CStr

Performs the conversion.

impl AsRef<str> for ConstCStr

fn as_ref(&self) -> &str

Performs the conversion.

impl Clone for ConstCStr

fn clone(&self) -> ConstCStr

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Copy for ConstCStr

impl Debug for ConstCStr

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

Formats the value using the given formatter.

impl Default for ConstCStr

fn default() -> ConstCStr

Returns an empty C string constant.

impl Display for ConstCStr

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

Formats the value using the given formatter.

impl Eq for ConstCStr

impl From<ConstCStr> for &'static str

fn from(c: ConstCStr) -> &'static str

Performs the conversion.

impl From<ConstCStr> for &'static [u8]

fn from(c: ConstCStr) -> &'static [u8]

Performs the conversion.

impl From<ConstCStr> for *const c_char

fn from(c: ConstCStr) -> *const c_char

Performs the conversion.

impl From<ConstCStr> for &'static CStr

fn from(c: ConstCStr) -> &'static CStr

Performs the conversion.

impl Hash for ConstCStr

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 Ord for ConstCStr

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

This method returns an [Ordering] between self and other.

#[must_use]fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

#[must_use]fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

#[must_use]fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialEq<ConstCStr> for ConstCStr

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

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

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

This method tests for !=.

impl PartialOrd<ConstCStr> for ConstCStr

fn partial_cmp(&self, other: &ConstCStr) -> Option<Ordering>

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

fn lt(&self, other: &ConstCStr) -> bool

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

fn le(&self, other: &ConstCStr) -> bool

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

fn gt(&self, other: &ConstCStr) -> bool

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

fn ge(&self, other: &ConstCStr) -> bool

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

impl StructuralEq for ConstCStr

impl StructuralPartialEq for ConstCStr