sentinel 0.5.4

A sentinel-terminated slice library.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

use core::ops::{Deref, DerefMut};

use crate::{SSlice, Sentinel};

/// A sentinel-terminated string that's backed by a fixed-size array.
pub type InlineCStr<const N: usize> = InlineSSlice<u8, N>;

/// A sentinel-terminated slice that's backed by a fixed-size array.
#[derive(Debug, Clone, Copy)]
pub struct InlineSSlice<T: Sentinel, const N: usize>([T; N]);

impl<T: Sentinel, const N: usize> InlineSSlice<T, N> {
    /// Creates a new [`InlineSSlice`] from a fixed-size array.
    ///
    /// # Safety
    ///
    /// `slice` must contain a sentinel value somewhere in it.
    #[inline(always)]
    pub const unsafe fn new_unchecked(slice: [T; N]) -> Self {
        Self(slice)
    }

    /// Attempts to create a new [`InlineSSlice`] from a fixed-size array.
    ///
    /// # Errors
    ///
    /// If the provided array does *not* contain a sentinel value, it is returned
    /// as an error.
    pub fn new(slice: [T; N]) -> Result<Self, [T; N]> {
        if T::find_sentinel(&slice).is_some() {
            Ok(Self(slice))
        } else {
            Err(slice)
        }
    }
}

impl<T: Sentinel, const N: usize> Deref for InlineSSlice<T, N> {
    type Target = SSlice<T>;

    #[inline(always)]
    fn deref(&self) -> &Self::Target {
        unsafe { SSlice::from_ptr(self.0.as_ptr()) }
    }
}

impl<T: Sentinel, const N: usize> DerefMut for InlineSSlice<T, N> {
    #[inline(always)]
    fn deref_mut(&mut self) -> &mut Self::Target {
        unsafe { SSlice::from_mut_ptr(self.0.as_mut_ptr()) }
    }
}

impl<T, U, const N: usize, const M: usize> PartialEq<InlineSSlice<U, M>> for InlineSSlice<T, N>
where
    T: PartialEq<U>,
    T: Sentinel,
    U: Sentinel,
{
    #[inline(always)]
    fn eq(&self, other: &InlineSSlice<U, M>) -> bool {
        **self == **other
    }
}

impl<T, U, const N: usize> PartialEq<SSlice<U>> for InlineSSlice<T, N>
where
    T: PartialEq<U>,
    T: Sentinel,
    U: Sentinel,
{
    #[inline(always)]
    fn eq(&self, other: &SSlice<U>) -> bool {
        **self == *other
    }
}

impl<T, U, const N: usize> PartialEq<[U]> for InlineSSlice<T, N>
where
    T: PartialEq<U>,
    T: Sentinel,
    U: Sentinel,
{
    #[inline(always)]
    fn eq(&self, other: &[U]) -> bool {
        **self == *other
    }
}

impl<T, U, const N: usize> PartialEq<InlineSSlice<U, N>> for [T]
where
    T: PartialEq<U>,
    T: Sentinel,
    U: Sentinel,
{
    #[inline(always)]
    fn eq(&self, other: &InlineSSlice<U, N>) -> bool {
        *self == **other
    }
}

impl<T, U, const N: usize> PartialEq<InlineSSlice<U, N>> for SSlice<T>
where
    T: PartialEq<U>,
    T: Sentinel,
    U: Sentinel,
{
    #[inline(always)]
    fn eq(&self, other: &InlineSSlice<U, N>) -> bool {
        *self == **other
    }
}

impl<T, const N: usize> AsRef<[T]> for InlineSSlice<T, N>
where
    T: Sentinel,
{
    #[inline(always)]
    fn as_ref(&self) -> &[T] {
        self.as_slice()
    }
}

impl<T, const N: usize> AsMut<[T]> for InlineSSlice<T, N>
where
    T: Sentinel,
{
    #[inline(always)]
    fn as_mut(&mut self) -> &mut [T] {
        self.as_slice_mut()
    }
}

impl<T, const N: usize> AsRef<SSlice<T>> for InlineSSlice<T, N>
where
    T: Sentinel,
{
    #[inline(always)]
    fn as_ref(&self) -> &SSlice<T> {
        self
    }
}

impl<T, const N: usize> AsMut<SSlice<T>> for InlineSSlice<T, N>
where
    T: Sentinel,
{
    #[inline(always)]
    fn as_mut(&mut self) -> &mut SSlice<T> {
        self
    }
}