Struct const_cstr::ConstCStr

pub struct ConstCStr {
    pub val: &'static str,
}

A type representing a static C-compatible string, wrapping &'static str.

Note

Prefer the const_cstr! macro to create an instance of this struct over manual initialization. The macro will include the NUL byte for you.

Fields

val: &'static str

The wrapped string value. Not intended to be used for manual initialization. Public only to allow initialization by the const_cstr! macro.

Includes the NUL terminating byte. Use to_str() to get an &'static str without the NUL terminating byte.

Methods

impl ConstCStr

fn to_str(&self) -> &'static str

Returns the wrapped string, without the NUL terminating byte.

Compare to CStr::to_str() which checks that the string is valid UTF-8 first, since it starts from an arbitrary pointer instead of a Rust string slice.

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

Returns the wrapped string as a byte slice, without the NUL terminating byte.

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

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

fn as_ptr(&self) -> *const c_char

Returns a pointer to the beginning of the wrapped string.

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.

Panics

If the wrapped string is not NUL-terminated. (Unlikely if you used the const_cstr! macro. This is just a sanity check.)

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

Returns the wrapped string as an &'static CStr, skipping the length check that CStr::from_ptr() performs (since we know the length already).

Panics

If the wrapped string is not NUL-terminated. (Unlikely if you used the const_cstr! macro. This is just a sanity check.)

Trait Implementations

impl Copy for ConstCStr

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

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

Formats the value using the given formatter.

impl PartialEq for ConstCStr

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

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

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

This method tests for !=.

impl Eq for ConstCStr

impl PartialOrd for ConstCStr

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

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

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

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

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

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

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

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

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

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

impl Ord for ConstCStr

fn cmp(&self, __arg_0: &ConstCStr) -> 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.

impl Hash for ConstCStr

fn hash<__H: Hasher>(&self, __arg_0: &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].