Coverage Report

Created: 2025-12-31 06:11

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/rust/registry/src/index.crates.io-1949cf8c6b5b557f/der-0.7.10/src/bytes_ref.rs
Line
Count
Source
1
//! Common handling for types backed by byte slices with enforcement of a
2
//! library-level length limitation i.e. `Length::max()`.
3
4
use crate::{
5
    DecodeValue, DerOrd, EncodeValue, Error, Header, Length, Reader, Result, StrRef, Writer,
6
};
7
use core::cmp::Ordering;
8
9
#[cfg(feature = "alloc")]
10
use crate::StrOwned;
11
12
/// Byte slice newtype which respects the `Length::max()` limit.
13
#[derive(Copy, Clone, Debug, Eq, PartialEq, PartialOrd, Ord)]
14
pub(crate) struct BytesRef<'a> {
15
    /// Precomputed `Length` (avoids possible panicking conversions)
16
    pub length: Length,
17
18
    /// Inner value
19
    pub inner: &'a [u8],
20
}
21
22
impl<'a> BytesRef<'a> {
23
    /// Constant value representing an empty byte slice.
24
    pub const EMPTY: Self = Self {
25
        length: Length::ZERO,
26
        inner: &[],
27
    };
28
29
    /// Create a new [`BytesRef`], ensuring that the provided `slice` value
30
    /// is shorter than `Length::max()`.
31
38.1k
    pub fn new(slice: &'a [u8]) -> Result<Self> {
32
        Ok(Self {
33
38.1k
            length: Length::try_from(slice.len())?,
34
38.1k
            inner: slice,
35
        })
36
38.1k
    }
Unexecuted instantiation: <der::bytes_ref::BytesRef>::new
<der::bytes_ref::BytesRef>::new
Line
Count
Source
31
38.1k
    pub fn new(slice: &'a [u8]) -> Result<Self> {
32
        Ok(Self {
33
38.1k
            length: Length::try_from(slice.len())?,
34
38.1k
            inner: slice,
35
        })
36
38.1k
    }
37
38
    /// Borrow the inner byte slice
39
871k
    pub fn as_slice(&self) -> &'a [u8] {
40
871k
        self.inner
41
871k
    }
Unexecuted instantiation: <der::bytes_ref::BytesRef>::as_slice
<der::bytes_ref::BytesRef>::as_slice
Line
Count
Source
39
871k
    pub fn as_slice(&self) -> &'a [u8] {
40
871k
        self.inner
41
871k
    }
42
43
    /// Get the [`Length`] of this [`BytesRef`]
44
3.97k
    pub fn len(self) -> Length {
45
3.97k
        self.length
46
3.97k
    }
Unexecuted instantiation: <der::bytes_ref::BytesRef>::len
<der::bytes_ref::BytesRef>::len
Line
Count
Source
44
3.97k
    pub fn len(self) -> Length {
45
3.97k
        self.length
46
3.97k
    }
47
48
    /// Is this [`BytesRef`] empty?
49
0
    pub fn is_empty(self) -> bool {
50
0
        self.len() == Length::ZERO
51
0
    }
Unexecuted instantiation: <der::bytes_ref::BytesRef>::is_empty
Unexecuted instantiation: <der::bytes_ref::BytesRef>::is_empty
52
}
53
54
impl AsRef<[u8]> for BytesRef<'_> {
55
0
    fn as_ref(&self) -> &[u8] {
56
0
        self.as_slice()
57
0
    }
Unexecuted instantiation: <der::bytes_ref::BytesRef as core::convert::AsRef<[u8]>>::as_ref
Unexecuted instantiation: <der::bytes_ref::BytesRef as core::convert::AsRef<[u8]>>::as_ref
58
}
59
60
impl<'a> DecodeValue<'a> for BytesRef<'a> {
61
29.6k
    fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
62
29.6k
        reader.read_slice(header.length).and_then(Self::new)
63
29.6k
    }
Unexecuted instantiation: <der::bytes_ref::BytesRef as der::decode::DecodeValue>::decode_value::<der::reader::nested::NestedReader<der::reader::nested::NestedReader<der::reader::nested::NestedReader<der::reader::nested::NestedReader<der::reader::nested::NestedReader<der::reader::slice::SliceReader>>>>>>
Unexecuted instantiation: <der::bytes_ref::BytesRef as der::decode::DecodeValue>::decode_value::<der::reader::nested::NestedReader<der::reader::nested::NestedReader<der::reader::nested::NestedReader<der::reader::nested::NestedReader<der::reader::slice::SliceReader>>>>>
Unexecuted instantiation: <der::bytes_ref::BytesRef as der::decode::DecodeValue>::decode_value::<der::reader::nested::NestedReader<der::reader::nested::NestedReader<der::reader::nested::NestedReader<der::reader::slice::SliceReader>>>>
Unexecuted instantiation: <der::bytes_ref::BytesRef as der::decode::DecodeValue>::decode_value::<der::reader::nested::NestedReader<der::reader::nested::NestedReader<der::reader::slice::SliceReader>>>
Unexecuted instantiation: <der::bytes_ref::BytesRef as der::decode::DecodeValue>::decode_value::<der::reader::nested::NestedReader<der::reader::slice::SliceReader>>
Unexecuted instantiation: <der::bytes_ref::BytesRef as der::decode::DecodeValue>::decode_value::<der::reader::slice::SliceReader>
<der::bytes_ref::BytesRef as der::decode::DecodeValue>::decode_value::<der::reader::nested::NestedReader<der::reader::nested::NestedReader<der::reader::nested::NestedReader<der::reader::nested::NestedReader<der::reader::nested::NestedReader<der::reader::slice::SliceReader>>>>>>
Line
Count
Source
61
23.1k
    fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
62
23.1k
        reader.read_slice(header.length).and_then(Self::new)
63
23.1k
    }
<der::bytes_ref::BytesRef as der::decode::DecodeValue>::decode_value::<der::reader::nested::NestedReader<der::reader::nested::NestedReader<der::reader::nested::NestedReader<der::reader::nested::NestedReader<der::reader::slice::SliceReader>>>>>
Line
Count
Source
61
237
    fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
62
237
        reader.read_slice(header.length).and_then(Self::new)
63
237
    }
<der::bytes_ref::BytesRef as der::decode::DecodeValue>::decode_value::<der::reader::nested::NestedReader<der::reader::nested::NestedReader<der::reader::nested::NestedReader<der::reader::slice::SliceReader>>>>
Line
Count
Source
61
3.78k
    fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
62
3.78k
        reader.read_slice(header.length).and_then(Self::new)
63
3.78k
    }
<der::bytes_ref::BytesRef as der::decode::DecodeValue>::decode_value::<der::reader::nested::NestedReader<der::reader::nested::NestedReader<der::reader::slice::SliceReader>>>
Line
Count
Source
61
2.45k
    fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
62
2.45k
        reader.read_slice(header.length).and_then(Self::new)
63
2.45k
    }
<der::bytes_ref::BytesRef as der::decode::DecodeValue>::decode_value::<der::reader::nested::NestedReader<der::reader::slice::SliceReader>>
Line
Count
Source
61
86
    fn decode_value<R: Reader<'a>>(reader: &mut R, header: Header) -> Result<Self> {
62
86
        reader.read_slice(header.length).and_then(Self::new)
63
86
    }
Unexecuted instantiation: <der::bytes_ref::BytesRef as der::decode::DecodeValue>::decode_value::<der::reader::slice::SliceReader>
64
}
65
66
impl EncodeValue for BytesRef<'_> {
67
0
    fn value_len(&self) -> Result<Length> {
68
0
        Ok(self.length)
69
0
    }
Unexecuted instantiation: <der::bytes_ref::BytesRef as der::encode::EncodeValue>::value_len
Unexecuted instantiation: <der::bytes_ref::BytesRef as der::encode::EncodeValue>::value_len
70
71
0
    fn encode_value(&self, writer: &mut impl Writer) -> Result<()> {
72
0
        writer.write(self.as_ref())
73
0
    }
Unexecuted instantiation: <der::bytes_ref::BytesRef as der::encode::EncodeValue>::encode_value::<der::writer::slice::SliceWriter>
Unexecuted instantiation: <der::bytes_ref::BytesRef as der::encode::EncodeValue>::encode_value::<_>
Unexecuted instantiation: <der::bytes_ref::BytesRef as der::encode::EncodeValue>::encode_value::<der::writer::slice::SliceWriter>
Unexecuted instantiation: <der::bytes_ref::BytesRef as der::encode::EncodeValue>::encode_value::<_>
74
}
75
76
impl Default for BytesRef<'_> {
77
0
    fn default() -> Self {
78
0
        Self {
79
0
            length: Length::ZERO,
80
0
            inner: &[],
81
0
        }
82
0
    }
Unexecuted instantiation: <der::bytes_ref::BytesRef as core::default::Default>::default
Unexecuted instantiation: <der::bytes_ref::BytesRef as core::default::Default>::default
83
}
84
85
impl DerOrd for BytesRef<'_> {
86
0
    fn der_cmp(&self, other: &Self) -> Result<Ordering> {
87
0
        Ok(self.as_slice().cmp(other.as_slice()))
88
0
    }
Unexecuted instantiation: <der::bytes_ref::BytesRef as der::ord::DerOrd>::der_cmp
Unexecuted instantiation: <der::bytes_ref::BytesRef as der::ord::DerOrd>::der_cmp
89
}
90
91
impl<'a> From<StrRef<'a>> for BytesRef<'a> {
92
0
    fn from(s: StrRef<'a>) -> BytesRef<'a> {
93
0
        let bytes = s.as_bytes();
94
0
        debug_assert_eq!(bytes.len(), usize::try_from(s.length).expect("overflow"));
95
96
0
        BytesRef {
97
0
            inner: bytes,
98
0
            length: s.length,
99
0
        }
100
0
    }
Unexecuted instantiation: <der::bytes_ref::BytesRef as core::convert::From<der::str_ref::StrRef>>::from
Unexecuted instantiation: <der::bytes_ref::BytesRef as core::convert::From<der::str_ref::StrRef>>::from
101
}
102
103
#[cfg(feature = "alloc")]
104
impl<'a> From<&'a StrOwned> for BytesRef<'a> {
105
0
    fn from(s: &'a StrOwned) -> BytesRef<'a> {
106
0
        let bytes = s.as_bytes();
107
0
        debug_assert_eq!(bytes.len(), usize::try_from(s.length).expect("overflow"));
108
109
0
        BytesRef {
110
0
            inner: bytes,
111
0
            length: s.length,
112
0
        }
113
0
    }
Unexecuted instantiation: <der::bytes_ref::BytesRef as core::convert::From<&der::str_owned::StrOwned>>::from
Unexecuted instantiation: <der::bytes_ref::BytesRef as core::convert::From<&der::str_owned::StrOwned>>::from
114
}
115
116
impl<'a> TryFrom<&'a [u8]> for BytesRef<'a> {
117
    type Error = Error;
118
119
0
    fn try_from(slice: &'a [u8]) -> Result<Self> {
120
0
        Self::new(slice)
121
0
    }
Unexecuted instantiation: <der::bytes_ref::BytesRef as core::convert::TryFrom<&[u8]>>::try_from
Unexecuted instantiation: <der::bytes_ref::BytesRef as core::convert::TryFrom<&[u8]>>::try_from
122
}
123
124
// Implement by hand because the derive would create invalid values.
125
// Make sure the length and the inner.len matches.
126
#[cfg(feature = "arbitrary")]
127
impl<'a> arbitrary::Arbitrary<'a> for BytesRef<'a> {
128
    fn arbitrary(u: &mut arbitrary::Unstructured<'a>) -> arbitrary::Result<Self> {
129
        let length = u.arbitrary()?;
130
        Ok(Self {
131
            length,
132
            inner: u.bytes(u32::from(length) as usize)?,
133
        })
134
    }
135
136
    fn size_hint(depth: usize) -> (usize, Option<usize>) {
137
        arbitrary::size_hint::and(Length::size_hint(depth), (0, None))
138
    }
139
}
140
141
#[cfg(feature = "alloc")]
142
mod allocating {
143
    use super::BytesRef;
144
    use crate::{referenced::RefToOwned, BytesOwned};
145
146
    impl<'a> RefToOwned<'a> for BytesRef<'a> {
147
        type Owned = BytesOwned;
148
0
        fn ref_to_owned(&self) -> Self::Owned {
149
0
            BytesOwned::from(*self)
150
0
        }
Unexecuted instantiation: <der::bytes_ref::BytesRef as der::referenced::RefToOwned>::ref_to_owned
Unexecuted instantiation: <der::bytes_ref::BytesRef as der::referenced::RefToOwned>::ref_to_owned
151
    }
152
}