Struct zstring::ZBytesRef

#[repr(transparent)]
pub struct ZBytesRef<'a> { /* fields omitted */ }

Borrows a non-null const pointer to zero-termianted bytes.

The bytes have no enforced encoding.

Because this is a “thin” pointer it’s suitable for direct use with FFI.

Implementations

impl<'a> ZBytesRef<'a>

pub const unsafe fn from_non_null_unchecked(nn: NonNull<u8>) -> Self

Turns a NonNull into a ZBytesRef

Safety

• The NonNull must point to a series of bytes that is null-terminated.

pub const fn iter(&self) -> ZBytesRefIter<'a>

Gets an iterator over the bytes.

The iterator does not return the final null byte.

pub fn as_slice_including_null(&self) -> &'a [u8]

Gets the full slice this points to, including the null byte.

Caution: This takes linear time to compute the slice length!

Trait Implementations

impl<'a> Binary for ZBytesRef<'a>

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

Formats the value using the given formatter.

impl<'a> Clone for ZBytesRef<'a>

fn clone(&self) -> ZBytesRef<'a>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for ZBytesRef<'a>

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

Formats the value using the given formatter.

impl<'a> Display for ZBytesRef<'a>

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

Formats the value using the given formatter.

impl<'a> Hash for ZBytesRef<'a>

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<'a> LowerExp for ZBytesRef<'a>

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

Formats the value using the given formatter.

impl<'a> LowerHex for ZBytesRef<'a>

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

Formats the value using the given formatter.

impl<'a> Octal for ZBytesRef<'a>

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

Formats the value using the given formatter.

impl<'a> Ord for ZBytesRef<'a>

fn cmp(&self, other: &ZBytesRef<'a>) -> 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

Restrict a value to a certain interval.

impl<'a> PartialEq<ZBytesRef<'a>> for ZBytesRef<'a>

fn eq(&self, other: &ZBytesRef<'a>) -> bool

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

fn ne(&self, other: &ZBytesRef<'a>) -> bool

This method tests for !=.

impl<'a> PartialOrd<ZBytesRef<'a>> for ZBytesRef<'a>

fn partial_cmp(&self, other: &ZBytesRef<'a>) -> Option<Ordering>

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

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

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

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

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

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

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

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

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

impl<'a> Pointer for ZBytesRef<'a>

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

Formats the value using the given formatter.

impl<'a, const N: usize> TryFrom<&'a [u8; N]> for ZBytesRef<'a>

type Error = ZBytesCreationError

The type returned in the event of a conversion error.

fn try_from(value: &'a [u8; N]) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> TryFrom<&'a [u8]> for ZBytesRef<'a>

type Error = ZBytesCreationError

The type returned in the event of a conversion error.

fn try_from(value: &'a [u8]) -> Result<Self, Self::Error>

Performs the conversion.

impl<'a> UpperExp for ZBytesRef<'a>

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

Formats the value using the given formatter.

impl<'a> UpperHex for ZBytesRef<'a>

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

Formats the value using the given formatter.

impl<'a> Copy for ZBytesRef<'a>

impl<'a> Eq for ZBytesRef<'a>

impl<'a> StructuralEq for ZBytesRef<'a>

impl<'a> StructuralPartialEq for ZBytesRef<'a>