Struct MeasuredNullTermStr

pub struct MeasuredNullTermStr<'s> { /* private fields */ }

The more direct analog to ffi::CStr which explicitly knows the length of its string data.

Implementations

impl<'s> MeasuredNullTermStr<'s>

pub const unsafe fn given_measurement(s: NullTermStr<'s>, n: usize) -> Self

Construct a C-style string with a known length.

Safety

The length n must correctly describe the number of bytes in the string value pointed to by s, without including the trailing null byte. This is to say that n may be 0, but the string pointed to by s must be non-null, and must point to a region of memory exactly 1 byte longer than n.

If the string’s length is not known in advance, use NullTermStr::measure(), which internally calls this method.

pub fn from_bytes_with_nul(s: &'s [u8]) -> Self

Translate a reference to a byte slice into a measured null-terminated string.

This method will panic if s is empty, if it does not end with a null byte, or if it contains any internal null bytes.

pub const unsafe fn from_bytes_with_nul_unchecked(s: &'s [u8]) -> Self

Translate a reference to a byte slice into a measured null-terminated string.

Safety

s must be non-empty, must end with a null byte, and may not contain any internal null bytes. Self::from_bytes_with_nul() may be used to validate slices.

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

Return a slice of the internal string data, without trailing null byte.

pub fn as_os_str(&self) -> &'s OsStr

Translate this data to a platform-specific string, suitable for translation to Path.

pub const fn len(&self) -> usize

Length of the internal string data, without trailing null byte.

pub const fn is_empty(&self) -> bool

Whether the internal string data points to a single null byte.

pub const fn len_with_nul(&self) -> usize

Length of the internal string data, with trailing null byte.

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

Return a slice of the internal string data, with trailing null byte.

pub const fn as_unmeasured(&self) -> NullTermStr<'s>

Retrieve the internal string data, which may be converted to a pointer again.

pub fn clone_into(&self, v: &mut NullTermString)

Allocate the necessary space in v and copy over the internal string data.

v’s length will be reset to the length of the internal string data, although it will not reallocate the underlying vector.

Trait Implementations

impl AsNullTermStr for MeasuredNullTermStr<'_>

fn as_null_term_str(&self) -> MeasuredNullTermStr<'_>

Similar to AsRef or Borrow.

impl<'s> Clone for MeasuredNullTermStr<'s>

fn clone(&self) -> MeasuredNullTermStr<'s>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MeasuredNullTermStr<'_>

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

Formats the value using the given formatter.

impl<'s> From<&'s [u8]> for MeasuredNullTermStr<'s>

fn from(s: &'s [u8]) -> Self

Converts to this type from the input type.

impl<'s> From<&'s CStr> for MeasuredNullTermStr<'s>

fn from(s: &'s CStr) -> Self

Converts to this type from the input type.

impl<'s> From<MeasuredNullTermStr<'s>> for &'s [u8]

fn from(s: MeasuredNullTermStr<'s>) -> Self

Converts to this type from the input type.

impl<'s> From<MeasuredNullTermStr<'s>> for &'s CStr

fn from(s: MeasuredNullTermStr<'s>) -> &'s CStr

Converts to this type from the input type.

impl Hash for MeasuredNullTermStr<'_>

fn hash<H>(&self, state: &mut H)

where H: Hasher,

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 Ord for MeasuredNullTermStr<'_>

fn cmp(&self, rhs: &Self) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

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

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for MeasuredNullTermStr<'_>

fn eq(&self, rhs: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for MeasuredNullTermStr<'_>

fn partial_cmp(&self, rhs: &Self) -> Option<Ordering>

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

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

Tests less than (for self and other) and is used by the < operator.

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

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

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

Tests greater than (for self and other) and is used by the > operator.

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

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

impl<'s> Copy for MeasuredNullTermStr<'s>

impl Eq for MeasuredNullTermStr<'_>