Skip to content

Commit 7679751

Browse files
Remove DefaultLenType functionality and the ZeroLengthType implementation
1 parent 5e7fefd commit 7679751

File tree

5 files changed

+2
-237
lines changed

5 files changed

+2
-237
lines changed

CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
2020
### Removed
2121

2222
- Removed invalid `bytes::Buf` implementation.
23+
- Removed `DefaultLenType` struct.
2324

2425
## [v0.9.0] - 2025-04-28 [YANKED]
2526

src/len_type.rs

-180
Original file line numberDiff line numberDiff line change
@@ -85,186 +85,6 @@ impl_lentype!(
8585
usize
8686
);
8787

88-
macro_rules! impl_lentodefault {
89-
($LenT:ty: $($len:literal),*) => {$(
90-
impl SmallestLenType for Const<$len> {
91-
type Type = $LenT;
92-
}
93-
)*};
94-
}
95-
96-
/// A struct to create individual types for mapping with [`SmallestLenType`].
97-
///
98-
/// See the documentation of [`DefaultLenType`] for a detailed explanation.
99-
pub struct Const<const N: usize>;
100-
101-
/// A trait to map [`Const`] to it's respective [`LenType`].
102-
///
103-
/// See the documentation of [`DefaultLenType`] for a detailed explanation.
104-
#[diagnostic::on_unimplemented(
105-
message = "Length `N` does not have a default `LenType` mapping",
106-
note = "Provide the `LenType` explicitly, such as `usize`"
107-
)]
108-
pub trait SmallestLenType {
109-
type Type: LenType;
110-
}
111-
112-
/// A type alias to perform the `const N: usize` -> `LenType` mapping.
113-
///
114-
/// This is impossible to perform directly, but it is possible to write a `const N: usize` -> related `Type` mapping via a const generic argument,
115-
/// then map from that to an unrelated type via a trait with associated types.
116-
///
117-
/// [`Const`] is the "related type" in the above explaination, [`SmallestLenType`] is the mapping trait.
118-
#[allow(rustdoc::private_intra_doc_links)] // Only publically exposed via `crate::_export`
119-
pub type DefaultLenType<const N: usize> = <Const<N> as SmallestLenType>::Type;
120-
121-
impl_lentodefault!(ZeroLenType: 0);
122-
impl_lentodefault!(u8: 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, 153, 154, 155, 156, 157, 158, 159, 160, 161, 162, 163, 164, 165, 166, 167, 168, 169, 170, 171, 172, 173, 174, 175, 176, 177, 178, 179, 180, 181, 182, 183, 184, 185, 186, 187, 188, 189, 190, 191, 192, 193, 194, 195, 196, 197, 198, 199, 200, 201, 202, 203, 204, 205, 206, 207, 208, 209, 210, 211, 212, 213, 214, 215, 216, 217, 218, 219, 220, 221, 222, 223, 224, 225, 226, 227, 228, 229, 230, 231, 232, 233, 234, 235, 236, 237, 238, 239, 240, 241, 242, 243, 244, 245, 246, 247, 248, 249, 250, 251, 252, 253, 254, 255);
123-
impl_lentodefault!(u16: 256, 300, 400, 500, 512, 600, 700, 800, 900, 1000, 1024, 2000, 2048, 4000, 4096, 8000, 8192, 16000, 16384, 32000, 32768, 65000, 65535);
124-
#[cfg(any(target_pointer_width = "32", target_pointer_width = "64"))]
125-
impl_lentodefault!(u32: 65536, 131072, 262144, 524288, 1048576, 2097152, 4194304, 8388608, 16777216, 33554432, 67108864, 134217728, 268435456, 536870912, 1073741824, 2147483648);
126-
12788
pub const fn check_capacity_fits<LenT: LenType, const N: usize>() {
12889
assert!(LenT::MAX_USIZE >= N, "The capacity is larger than `LenT` can hold, increase the size of `LenT` or reduce the capacity");
12990
}
130-
131-
/// Container with 0 capacity always has length 0, so there is no need to track length of such containers at all.
132-
///
133-
/// This type is used as a placeholder for length of container with 0 capacity. It allows optimizing total size of
134-
/// containers like this to 0 bytes.
135-
///
136-
/// Logically, this type always stores value 0. Because of this ZeroLenType::one() panics and should never be called.
137-
#[doc(hidden)]
138-
#[derive(Copy, Clone, PartialEq, PartialOrd)]
139-
pub struct ZeroLenType;
140-
141-
impl Debug for ZeroLenType {
142-
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
143-
write!(f, "0")
144-
}
145-
}
146-
147-
impl Display for ZeroLenType {
148-
fn fmt(&self, f: &mut core::fmt::Formatter<'_>) -> core::fmt::Result {
149-
write!(f, "0")
150-
}
151-
}
152-
153-
impl Sealed for ZeroLenType {
154-
const ZERO: Self = Self;
155-
156-
const MAX: Self = Self;
157-
const MAX_USIZE: usize = 0;
158-
159-
#[inline]
160-
fn one() -> Self {
161-
panic!("ZeroLenType cannot represent value 1");
162-
}
163-
}
164-
165-
impl LenType for ZeroLenType {}
166-
167-
impl Add for ZeroLenType {
168-
type Output = Self;
169-
170-
fn add(self, _rhs: Self) -> Self::Output {
171-
Self::ZERO
172-
}
173-
}
174-
175-
impl AddAssign for ZeroLenType {
176-
fn add_assign(&mut self, _rhs: Self) {}
177-
}
178-
179-
impl Sub for ZeroLenType {
180-
type Output = Self;
181-
182-
fn sub(self, _rhs: Self) -> Self::Output {
183-
Self::ZERO
184-
}
185-
}
186-
187-
impl SubAssign for ZeroLenType {
188-
fn sub_assign(&mut self, _rhs: Self) {}
189-
}
190-
191-
#[doc(hidden)]
192-
#[derive(Debug, PartialEq)]
193-
pub struct ZeroLenTypeTryFromError;
194-
195-
impl TryFrom<usize> for ZeroLenType {
196-
type Error = ZeroLenTypeTryFromError;
197-
198-
fn try_from(value: usize) -> Result<Self, Self::Error> {
199-
if value > 0 {
200-
return Err(ZeroLenTypeTryFromError);
201-
}
202-
203-
Ok(Self::ZERO)
204-
}
205-
}
206-
207-
impl TryInto<usize> for ZeroLenType {
208-
type Error = ();
209-
210-
fn try_into(self) -> Result<usize, Self::Error> {
211-
Ok(0)
212-
}
213-
}
214-
215-
#[cfg(test)]
216-
mod tests {
217-
use crate::len_type::{Sealed, ZeroLenType, ZeroLenTypeTryFromError};
218-
219-
#[test]
220-
pub fn test_zero_len_type_conversions() {
221-
assert_eq!(ZeroLenType::into_usize(ZeroLenType::ZERO), 0_usize);
222-
assert_eq!(ZeroLenType::from_usize(0_usize), ZeroLenType::ZERO);
223-
224-
assert_eq!(ZeroLenType::ZERO.try_into(), Ok(0_usize));
225-
assert_eq!(ZeroLenType::try_from(0_usize), Ok(ZeroLenType::ZERO));
226-
assert_eq!(ZeroLenType::try_from(1_usize), Err(ZeroLenTypeTryFromError));
227-
}
228-
229-
#[test]
230-
#[should_panic]
231-
pub fn test_zero_len_type_one() {
232-
ZeroLenType::one();
233-
}
234-
235-
#[test]
236-
#[should_panic]
237-
pub fn test_zero_len_type_one_usize() {
238-
ZeroLenType::from_usize(1);
239-
}
240-
241-
#[test]
242-
pub fn test_zero_len_type_constants() {
243-
assert_eq!(ZeroLenType::ZERO, ZeroLenType);
244-
assert_eq!(ZeroLenType::MAX, ZeroLenType);
245-
assert_eq!(ZeroLenType::MAX_USIZE, 0_usize);
246-
}
247-
248-
#[test]
249-
pub fn test_zero_len_type_size() {
250-
assert_eq!(core::mem::size_of::<ZeroLenType>(), 0);
251-
}
252-
253-
#[test]
254-
pub fn test_zero_len_type_ops() {
255-
assert_eq!(ZeroLenType::ZERO + ZeroLenType::ZERO, ZeroLenType::ZERO);
256-
assert_eq!(ZeroLenType::ZERO - ZeroLenType::ZERO, ZeroLenType::ZERO);
257-
258-
let mut zero = ZeroLenType::ZERO;
259-
zero += ZeroLenType::ZERO;
260-
assert_eq!(zero, ZeroLenType::ZERO);
261-
zero -= ZeroLenType::ZERO;
262-
assert_eq!(zero, ZeroLenType::ZERO);
263-
}
264-
265-
#[test]
266-
pub fn test_zero_len_type_debug() {
267-
assert_eq!(format!("{}", ZeroLenType), "0");
268-
assert_eq!(format!("{:?}", ZeroLenType), "0");
269-
}
270-
}

src/lib.rs

-1
Original file line numberDiff line numberDiff line change
@@ -241,7 +241,6 @@ mod ufmt;
241241
/// Do not use. Used for macros only. Not covered by semver guarantees.
242242
#[doc(hidden)]
243243
pub mod _export {
244-
pub use crate::len_type::DefaultLenType;
245244
pub use crate::string::format;
246245
}
247246

src/string/mod.rs

+1-26
Original file line numberDiff line numberDiff line change
@@ -977,7 +977,7 @@ impl_try_from_num!(u64, 20);
977977

978978
#[cfg(test)]
979979
mod tests {
980-
use crate::{len_type::ZeroLenType, CapacityError, String, Vec};
980+
use crate::{CapacityError, String, Vec};
981981

982982
#[test]
983983
fn static_new() {
@@ -1240,29 +1240,4 @@ mod tests {
12401240
let formatted = format!(2; "123");
12411241
assert_eq!(formatted, Err(core::fmt::Error));
12421242
}
1243-
1244-
#[test]
1245-
fn zero_capacity() {
1246-
let mut s: String<0, ZeroLenType> = String::new();
1247-
// Validate capacity
1248-
assert_eq!(s.capacity(), 0);
1249-
1250-
// Make sure there is no capacity
1251-
assert!(s.push('a').is_err());
1252-
1253-
// Validate length
1254-
assert_eq!(s.len(), 0);
1255-
1256-
// Validate pop
1257-
assert_eq!(s.pop(), None);
1258-
1259-
// Validate slice
1260-
assert_eq!(s.as_str(), "");
1261-
1262-
// Validate empty
1263-
assert!(s.is_empty());
1264-
1265-
// Size of string with zero capacity should be 0 bytes because of `ZeroLenType` optimization
1266-
assert_eq!(core::mem::size_of_val(&s), 0);
1267-
}
12681243
}

src/vec/mod.rs

-30
Original file line numberDiff line numberDiff line change
@@ -1737,8 +1737,6 @@ mod tests {
17371737

17381738
use static_assertions::assert_not_impl_any;
17391739

1740-
use crate::len_type::ZeroLenType;
1741-
17421740
use super::{Vec, VecView};
17431741

17441742
// Ensure a `Vec` containing `!Send` values stays `!Send` itself.
@@ -2182,34 +2180,6 @@ mod tests {
21822180
assert!(!v.ends_with(b"a"));
21832181
}
21842182

2185-
#[test]
2186-
fn zero_capacity() {
2187-
let mut v: Vec<u8, 0, ZeroLenType> = Vec::new();
2188-
// Validate capacity
2189-
assert_eq!(v.capacity(), 0);
2190-
2191-
// Make sure there is no capacity
2192-
assert!(v.push(1).is_err());
2193-
2194-
// Validate length
2195-
assert_eq!(v.len(), 0);
2196-
2197-
// Validate pop
2198-
assert_eq!(v.pop(), None);
2199-
2200-
// Validate slice
2201-
assert_eq!(v.as_slice(), &[]);
2202-
2203-
// Validate empty
2204-
assert!(v.is_empty());
2205-
2206-
// Validate full
2207-
assert!(v.is_full());
2208-
2209-
// Size of vector with zero capacity should be 0 bytes because of `ZeroLenType` optimization
2210-
assert_eq!(core::mem::size_of_val(&v), 0);
2211-
}
2212-
22132183
#[test]
22142184
fn spare_capacity_mut() {
22152185
let mut v: Vec<_, 4> = Vec::new();

0 commit comments

Comments
 (0)