Struct null_terminated::Nul

#[repr(C)]
pub struct Nul<A>(_, _);

Generic unsized null-terminated array

&Nul<A> is a thin pointer, so it can be readily used with FFI.

Examples

One can safely take views of null-terminated slices with TryFrom::try_from:

extern "C" {
    fn c_f(path: *const u8) -> i32;
}

fn f(path: &[u8]) -> Result<i32, ()> {
    <&Nul<u8> as ::fallible::TryFrom<_>>::try_from(path)
        .map(|path| unsafe { c_f(path.as_ptr()) })
}

Methods

impl<A> Nul<A>

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

Return a pointer to the start of the array.

pub fn as_mut_ptr(&mut self) -> *mut A

Return a mutable pointer to the start of the array.

Important traits for Iter<'a, A>

impl<'a, A: 'a> Iterator for Iter<'a, A> type Item = &'a A;

pub const fn iter(&self) -> Iter<A>

Iterate over array elements.

Important traits for IterMut<'a, A>

impl<'a, A: 'a> Iterator for IterMut<'a, A> type Item = &'a mut A;

pub fn iter_mut(&mut self) -> IterMut<A>

Iterate over array elements, mutably.

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

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

The caller must make sure the argument does, in fact, point to a null-terminated array, 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 A) -> &'static mut Self

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

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

pub fn len(&self) -> usize

Return array length. O(n)

pub fn get(&self, i: usize) -> Option<&A>

Get element at given position. O(n) to check bounds

pub fn get_mut(&mut self, i: usize) -> Option<&mut A>

Get element at given position, mutably. O(n) to check bounds

pub fn split_at(&self, i: usize) -> (&[A], &Self)

Split array at given position.

Panics

Panics if index out of bounds.

pub fn split_at_mut(&mut self, i: usize) -> (&mut [A], &mut Self)

Split array at given position, mutably.

Panics

Panics if index out of bounds.

pub fn try_split_at(&self, i: usize) -> Option<(&[A], &Self)>

Split array at given position; return None if index out of bounds.

pub fn try_split_at_mut(&mut self, i: usize) -> Option<(&mut [A], &mut Self)>

Split array at given position, mutably; return None if index out of bounds.

Trait Implementations

impl<A: PartialEq> PartialEq<Nul<A>> for Nul<A>

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

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

#[must_use]

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

This method tests for !=.

impl<A: Eq> Eq for Nul<A>

impl<A: Ord> Ord for Nul<A>

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

This method returns an Ordering between self and other.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

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

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

Restrict a value to a certain interval.

impl<A: PartialOrd> PartialOrd<Nul<A>> for Nul<A>

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

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

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

#[must_use]

default 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, A> From<Iter<'a, A>> for &'a Nul<A>

fn from(it: Iter<'a, A>) -> Self

Performs the conversion.

impl<'a, A> From<IterMut<'a, A>> for &'a mut Nul<A>

fn from(it: IterMut<'a, A>) -> Self

Performs the conversion.

impl<A: Debug> Debug for Nul<A>

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

Formats the value using the given formatter.

impl Display for Nul<char>

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

Formats the value using the given formatter.

impl<A, I> Index<I> for Nul<A> where
    [A]: Index<I>, 

type Output = <[A] as Index<I>>::Output

The returned type after indexing.

fn index(&self, i: I) -> &Self::Output

Performs the indexing (container[index]) operation.

impl<A, I> IndexMut<I> for Nul<A> where
    [A]: IndexMut<I>, 

fn index_mut(&mut self, i: I) -> &mut Self::Output

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

impl<A: Hash> Hash for Nul<A>

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

Feeds this value into the given [Hasher].

default fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given [Hasher].

impl<'a, A> IntoIterator for &'a Nul<A>

type Item = &'a A

The type of the elements being iterated over.

type IntoIter = Iter<'a, A>

Which kind of iterator are we turning this into?

Important traits for Iter<'a, A>

impl<'a, A: 'a> Iterator for Iter<'a, A> type Item = &'a A;

fn into_iter(self) -> Iter<'a, A>

Creates an iterator from a value.

impl<'a, A> IntoIterator for &'a mut Nul<A>

type Item = &'a mut A

The type of the elements being iterated over.

type IntoIter = IterMut<'a, A>

Which kind of iterator are we turning this into?

Important traits for IterMut<'a, A>

impl<'a, A: 'a> Iterator for IterMut<'a, A> type Item = &'a mut A;

fn into_iter(self) -> IterMut<'a, A>

Creates an iterator from a value.

impl<A> AsRef<Nul<A>> for Nul<A>

fn as_ref(&self) -> &Self

Performs the conversion.

impl<'a, A> TryFrom<&'a [A]> for &'a Nul<A>

type Error = ()

fn try_from(xs: &'a [A]) -> Result<Self, ()>

impl<'a, A> TryFrom<&'a mut [A]> for &'a mut Nul<A>

type Error = ()

fn try_from(xs: &'a mut [A]) -> Result<Self, ()>

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

type Error = Utf8Error

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

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

type Error = Utf8Error

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