Struct null_terminated::NulStr

#[repr(transparent)]
pub struct NulStr(_);

Null-terminated UTF-8 encoded string

&NulStr is a thin pointer, so it can be readily used with FFI.

One can convert from &Nul<u8> to &NulStr with try_from, which checks whether its argument is valid UTF-8.

Methods

impl NulStr

pub const unsafe fn new_unchecked(p: *const u8) -> &'static Self

Create a reference to a null-terminated string, given a pointer to its start.

The caller must make sure the argument does, in fact, point to a null-terminated string; the string is valid UTF-8; and the returned reference not live longer than the array it refers to. These requirements are not checked.

pub unsafe fn new_unchecked_mut(p: *mut u8) -> &'static mut Self

Create a mutable reference to a null-terminated string, given a pointer to its start.

The caller must make sure the argument does, in fact, point to a null-terminated string; the string is valid UTF-8; and the returned reference not live longer than the array it refers to. These requirements are not checked.

pub fn as_bytes(&self) -> &Nul<u8>

Return a slice of the UTF-8 code bytes of the string.

pub fn as_bytes_mut(&mut self) -> &mut Nul<u8>

Return a mutable slice of the UTF-8 code bytes of the string.

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

Return a pointer to the start of the string.

pub fn as_mut_ptr(&mut self) -> *const u8

Return a mutable pointer to the start of the string.

Important traits for Chars<'a>

impl<'a> Iterator for Chars<'a> type Item = char;

pub fn chars(&self) -> Chars

Iterate over the characters of the string.

Important traits for CharIndices<'a>

impl<'a> Iterator for CharIndices<'a> type Item = (usize, char);

pub fn char_indices(&self) -> CharIndices

Iterate over the characters of the string and their byte positions.

pub fn is_char_boundary(&self, k: usize) -> bool

Return whether the given byte position is a character boundary.

Trait Implementations

impl Debug for NulStr

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

Formats the value using the given formatter.

impl Display for NulStr

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

Formats the value using the given formatter.

impl PartialEq<NulStr> for NulStr

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

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

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

This method tests for !=.

impl Eq for NulStr

impl Ord for NulStr

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

fn clamp(self, min: Self, max: Self) -> Self

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

Restrict a value to a certain interval.

impl PartialOrd<NulStr> for NulStr

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

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

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

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

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

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

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

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

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

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

impl<'a> TryFrom<&'a Nul<u8>> for &'a NulStr

type Error = Utf8Error

The type returned in the event of a conversion error.

fn try_from(s: &'a Nul<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a mut Nul<u8>> for &'a mut NulStr

type Error = Utf8Error

The type returned in the event of a conversion error.

fn try_from(s: &'a mut Nul<u8>) -> Result<Self, Self::Error>

Performs the conversion.

impl Index<RangeFull> for NulStr

type Output = str

The returned type after indexing.

fn index(&self, _: RangeFull) -> &str

Performs the indexing (container[index]) operation.

impl IndexMut<RangeFull> for NulStr

fn index_mut(&mut self, _: RangeFull) -> &mut str

Performs the mutable indexing (container[index]) operation.

impl Hash for NulStr

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 StructuralPartialEq for NulStr

impl StructuralEq for NulStr