15134909761

Committed 20 May 2025 10:15AM UTC coverage: 57.211% (+0.05%) from 57.157%

Build # 15134909761

Build Type

push

github

Committed by

fasterthanlime

Commit Message

Add `next_back` impl for `BTreeSet` iter

Run Details

0 of 7 new or added lines in 1 file covered. (0.0%)

101 existing lines in 5 files now uncovered.

9303 of 16261 relevant lines covered (57.21%)

132.28 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

66.67

/facet-core/src/impls_std/hashset.rs

use core::hash::{BuildHasher, Hash};
use std::collections::HashSet;

use crate::ptr::{PtrConst, PtrMut};

use crate::{
    Def, Facet, IterVTable, MarkerTraits, SetDef, SetVTable, Shape, Type, TypeParam, UserType,
    VTableView, ValueVTable,
};

type HashSetIterator<'mem, T> = std::collections::hash_set::Iter<'mem, T>;

unsafe impl<'a, T, S> Facet<'a> for HashSet<T, S>
where
    T: Facet<'a> + core::cmp::Eq + core::hash::Hash,
    S: Facet<'a> + Default + BuildHasher,
{
    const VTABLE: &'static ValueVTable = &const {
        let mut builder = ValueVTable::builder::<Self>()
            .marker_traits(
                MarkerTraits::SEND
                    .union(MarkerTraits::SYNC)
                    .union(MarkerTraits::EQ)
                    .union(MarkerTraits::UNPIN)
                    .intersection(T::SHAPE.vtable.marker_traits),
            )
            .type_name(|f, opts| {
                if let Some(opts) = opts.for_children() {
                    write!(f, "HashSet<")?;
                    (T::SHAPE.vtable.type_name)(f, opts)?;
                    write!(f, ">")
                } else {
                    write!(f, "HashSet<⋯>")
                }
            })
            .default_in_place(|target| unsafe { target.put(Self::default()) })
            .eq(|a, b| a == b);

        if T::SHAPE.vtable.debug.is_some() {
            builder = builder.debug(|value, f| {
                let t_debug = <VTableView<T>>::of().debug().unwrap();
                write!(f, "{{")?;
                for (i, item) in value.iter().enumerate() {
                    if i > 0 {
                        write!(f, ", ")?;
                    }
                    (t_debug)(item, f)?;
                }
                write!(f, "}}")
            });
        }

        if T::SHAPE.vtable.clone_into.is_some() {
            builder = builder.clone_into(|src, dst| unsafe {
                let set = src;
                let mut new_set = HashSet::with_capacity_and_hasher(set.len(), S::default());

                let t_clone_into = <VTableView<T>>::of().clone_into().unwrap();

                for item in set {
                    use crate::TypedPtrUninit;
                    use core::mem::MaybeUninit;

                    let mut new_item = MaybeUninit::<T>::uninit();
                    let uninit_item = TypedPtrUninit::new(new_item.as_mut_ptr());

                    (t_clone_into)(item, uninit_item);

                    new_set.insert(new_item.assume_init());
                }

                dst.put(new_set)
            });
        }

        if T::SHAPE.vtable.hash.is_some() {
            builder = builder.hash(|set, hasher_this, hasher_write_fn| unsafe {
                use crate::HasherProxy;
                let t_hash = <VTableView<T>>::of().hash().unwrap();
                let mut hasher = HasherProxy::new(hasher_this, hasher_write_fn);
                set.len().hash(&mut hasher);
                for item in set {
                    (t_hash)(item, hasher_this, hasher_write_fn);
                }
            });
        }

        builder.build()
    };

    const SHAPE: &'static Shape<'static> = &const {
        Shape::builder_for_sized::<Self>()
            .type_params(&[
                TypeParam {
                    name: "T",
                    shape: || T::SHAPE,
                },
                TypeParam {
                    name: "S",
                    shape: || S::SHAPE,
                },
            ])
            .ty(Type::User(UserType::Opaque))
            .def(Def::Set(
                SetDef::builder()
                    .t(|| T::SHAPE)
                    .vtable(
                        &const {
                            SetVTable::builder()
                                .init_in_place_with_capacity(|uninit, capacity| unsafe {
                                    uninit
                                        .put(Self::with_capacity_and_hasher(capacity, S::default()))
                                })
                                .insert(|ptr, item| unsafe {
                                    let set = ptr.as_mut::<HashSet<T>>();
                                    let item = item.read::<T>();
                                    set.insert(item)
                                })
                                .len(|ptr| unsafe {
                                    let set = ptr.get::<HashSet<T>>();
                                    set.len()
                                })
                                .contains(|ptr, item| unsafe {
                                    let set = ptr.get::<HashSet<T>>();
                                    set.contains(item.get())
                                })
                                .iter_vtable(
                                    IterVTable::builder()
                                        .init_with_value(|ptr| unsafe {
                                            let set = ptr.get::<HashSet<T>>();
                                            let iter: HashSetIterator<'_, T> = set.iter();
                                            let iter_state = Box::new(iter);
                                            PtrMut::new(Box::into_raw(iter_state) as *mut u8)
                                        })
                                        .next(|iter_ptr| unsafe {
                                            let state = iter_ptr.as_mut::<HashSetIterator<'_, T>>();
                                            state.next().map(|value| PtrConst::new(value))
                                        })
                                        .dealloc(|iter_ptr| unsafe {
                                            drop(Box::from_raw(
                                                iter_ptr.as_ptr::<HashSetIterator<'_, T>>()
                                                    as *mut HashSetIterator<'_, T>,
                                            ));
                                        })
                                        .build(),
                                )
                                .build()
                        },
                    )
                    .build(),
            ))
            .build()
    };
}

#[cfg(test)]
mod tests {
    use alloc::string::String;
    use std::collections::HashSet;
    use std::hash::RandomState;

    use super::*;

    #[test]
    fn test_hashset_type_params() {
        // HashSet should have a type param for both its value type
        // and its hasher state
        let [type_param_1, type_param_2] = <HashSet<i32>>::SHAPE.type_params else {
            panic!("HashSet<T> should have 2 type params")
        };
        assert_eq!(type_param_1.shape(), i32::SHAPE);
        assert_eq!(type_param_2.shape(), RandomState::SHAPE);
    }

    #[test]
    fn test_hashset_vtable_1_new_insert_iter_drop() -> eyre::Result<()> {
        facet_testhelpers::setup();

        let hashset_shape = <HashSet<String>>::SHAPE;
        let hashset_def = hashset_shape
            .def
            .into_set()
            .expect("HashSet<T> should have a set definition");

        // Allocate memory for the HashSet
        let hashset_uninit_ptr = hashset_shape.allocate()?;

        // Create the HashSet with a capacity of 3
        let hashset_ptr =
            unsafe { (hashset_def.vtable.init_in_place_with_capacity_fn)(hashset_uninit_ptr, 3) };

        // The HashSet is empty, so ensure its length is 0
        let hashset_actual_length = unsafe { (hashset_def.vtable.len_fn)(hashset_ptr.as_const()) };
        assert_eq!(hashset_actual_length, 0);

        // 5 sample values to insert
        let strings = ["foo", "bar", "bazz", "fizzbuzz", "fifth thing"];

        // Insert the 5 values into the HashSet
        let mut hashset_length = 0;
        for string in strings {
            // Create the value
            let mut new_value = string.to_string();

            // Insert the value
            let did_insert = unsafe {
                (hashset_def.vtable.insert_fn)(hashset_ptr, PtrMut::new(&raw mut new_value))
            };

            // The value now belongs to the HashSet, so forget it
            core::mem::forget(new_value);

            assert!(did_insert, "expected value to be inserted in the HashSet");

            // Ensure the HashSet's length increased by 1
            hashset_length += 1;
            let hashset_actual_length =
                unsafe { (hashset_def.vtable.len_fn)(hashset_ptr.as_const()) };
            assert_eq!(hashset_actual_length, hashset_length);
        }

        // Insert the same 5 values again, ensuring they are deduplicated
        for string in strings {
            // Create the value
            let mut new_value = string.to_string();

            // Try to insert the value
            let did_insert = unsafe {
                (hashset_def.vtable.insert_fn)(hashset_ptr, PtrMut::new(&raw mut new_value))
            };

            // The value now belongs to the HashSet, so forget it
            core::mem::forget(new_value);

            assert!(
                !did_insert,
                "expected value to not be inserted in the HashSet"
            );

            // Ensure the HashSet's length did not increase
            let hashset_actual_length =
                unsafe { (hashset_def.vtable.len_fn)(hashset_ptr.as_const()) };
            assert_eq!(hashset_actual_length, hashset_length);
        }

        // Create a new iterator over the HashSet
        let iter_init_with_value_fn = hashset_def.vtable.iter_vtable.init_with_value.unwrap();
        let hashset_iter_ptr = unsafe { iter_init_with_value_fn(hashset_ptr.as_const()) };

        // Collect all the items from the HashSet's iterator
        let mut iter_items = HashSet::<&str>::new();
        loop {
            // Get the next item from the iterator
            let item_ptr = unsafe { (hashset_def.vtable.iter_vtable.next)(hashset_iter_ptr) };
            let Some(item_ptr) = item_ptr else {
                break;
            };

            let item = unsafe { item_ptr.get::<String>() };

            // Insert the item into the set of items returned from the iterator
            let did_insert = iter_items.insert(&**item);

            assert!(did_insert, "HashSet iterator returned duplicate item");
        }

        // Deallocate the iterator
        unsafe {
            (hashset_def.vtable.iter_vtable.dealloc)(hashset_iter_ptr);
        }

        // Ensure the iterator returned all of the strings
        assert_eq!(iter_items, strings.iter().copied().collect::<HashSet<_>>());

        // Get the function pointer for dropping the HashSet
        let drop_fn = hashset_shape
            .vtable
            .drop_in_place
            .expect("HashSet<T> should have drop_in_place");

        // Drop the HashSet in place
        unsafe { drop_fn(hashset_ptr) };

        // Deallocate the memory
        unsafe { hashset_shape.deallocate_mut(hashset_ptr)? };

        Ok(())
    }
}

1	use core::hash::{BuildHasher, Hash};
2	use std::collections::HashSet;
3
4	use crate::ptr::{PtrConst, PtrMut};
5
6	use crate::{
7	Def, Facet, IterVTable, MarkerTraits, SetDef, SetVTable, Shape, Type, TypeParam, UserType,
8	VTableView, ValueVTable,
9	};
10
11	type HashSetIterator<'mem, T> = std::collections::hash_set::Iter<'mem, T>;
12
13	unsafe impl<'a, T, S> Facet<'a> for HashSet<T, S>
14	where
15	T: Facet<'a> + core::cmp::Eq + core::hash::Hash,
16	S: Facet<'a> + Default + BuildHasher,
17	{
18	const VTABLE: &'static ValueVTable = &const {
19	let mut builder = ValueVTable::builder::<Self>()
20	.marker_traits(
21	MarkerTraits::SEND
22	.union(MarkerTraits::SYNC)
23	.union(MarkerTraits::EQ)
24	.union(MarkerTraits::UNPIN)
25	.intersection(T::SHAPE.vtable.marker_traits),
26	)
UNCOV 27	.type_name(\|f, opts\| {	×
UNCOV 28	if let Some(opts) = opts.for_children() {	×
UNCOV 29	write!(f, "HashSet<")?;	×
30	(T::SHAPE.vtable.type_name)(f, opts)?;	×
31	write!(f, ">")	×
32	} else {
33	write!(f, "HashSet<⋯>")	×
34	}
UNCOV 35	})	×
36	.default_in_place(\|target\| unsafe { target.put(Self::default()) })	×
UNCOV 37	.eq(\|a, b\| a == b);	×
38
39	if T::SHAPE.vtable.debug.is_some() {
40	builder = builder.debug(\|value, f\| {	×
UNCOV 41	let t_debug = <VTableView<T>>::of().debug().unwrap();	×
UNCOV 42	write!(f, "{{")?;	×
43	for (i, item) in value.iter().enumerate() {	×
44	if i > 0 {	×
45	write!(f, ", ")?;	×
46	}	×
47	(t_debug)(item, f)?;	×
48	}
49	write!(f, "}}")	×
50	});	×
51	}
52
53	if T::SHAPE.vtable.clone_into.is_some() {
54	builder = builder.clone_into(\|src, dst\| unsafe {
UNCOV 55	let set = src;	×
UNCOV 56	let mut new_set = HashSet::with_capacity_and_hasher(set.len(), S::default());	×
57
58	let t_clone_into = <VTableView<T>>::of().clone_into().unwrap();	×
59
UNCOV 60	for item in set {	×
61	use crate::TypedPtrUninit;
62	use core::mem::MaybeUninit;
63
UNCOV 64	let mut new_item = MaybeUninit::<T>::uninit();	×
UNCOV 65	let uninit_item = TypedPtrUninit::new(new_item.as_mut_ptr());	×
66
67	(t_clone_into)(item, uninit_item);	×
68
UNCOV 69	new_set.insert(new_item.assume_init());	×
70	}
71
72	dst.put(new_set)	×
UNCOV 73	});	×
74	}
75
76	if T::SHAPE.vtable.hash.is_some() {
77	builder = builder.hash(\|set, hasher_this, hasher_write_fn\| unsafe {
78	use crate::HasherProxy;
UNCOV 79	let t_hash = <VTableView<T>>::of().hash().unwrap();	×
UNCOV 80	let mut hasher = HasherProxy::new(hasher_this, hasher_write_fn);	×
UNCOV 81	set.len().hash(&mut hasher);	×
82	for item in set {	×
83	(t_hash)(item, hasher_this, hasher_write_fn);	×
84	}	×
85	});	×
86	}
87
88	builder.build()
89	};
90
91	const SHAPE: &'static Shape<'static> = &const {
92	Shape::builder_for_sized::<Self>()
93	.type_params(&[
94	TypeParam {
95	name: "T",
96	shape: \|\| T::SHAPE,
97	},
98	TypeParam {
99	name: "S",
100	shape: \|\| S::SHAPE,
101	},
102	])
103	.ty(Type::User(UserType::Opaque))
104	.def(Def::Set(
105	SetDef::builder()
106	.t(\|\| T::SHAPE)
107	.vtable(
108	&const {
109	SetVTable::builder()
110	.init_in_place_with_capacity(\|uninit, capacity\| unsafe {
111	uninit	1✔
112	.put(Self::with_capacity_and_hasher(capacity, S::default()))	1✔
113	})	1✔
114	.insert(\|ptr, item\| unsafe {
115	let set = ptr.as_mut::<HashSet<T>>();	10✔
116	let item = item.read::<T>();	10✔
117	set.insert(item)	10✔
118	})	10✔
119	.len(\|ptr\| unsafe {
120	let set = ptr.get::<HashSet<T>>();	11✔
121	set.len()	11✔
122	})	11✔
123	.contains(\|ptr, item\| unsafe {
UNCOV 124	let set = ptr.get::<HashSet<T>>();	×
UNCOV 125	set.contains(item.get())	×
UNCOV 126	})	×
127	.iter_vtable(
128	IterVTable::builder()
129	.init_with_value(\|ptr\| unsafe {
130	let set = ptr.get::<HashSet<T>>();	1✔
131	let iter: HashSetIterator<'_, T> = set.iter();	1✔
132	let iter_state = Box::new(iter);	1✔
133	PtrMut::new(Box::into_raw(iter_state) as *mut u8)	1✔
134	})	1✔
135	.next(\|iter_ptr\| unsafe {
136	let state = iter_ptr.as_mut::<HashSetIterator<'_, T>>();	6✔
137	state.next().map(\|value\| PtrConst::new(value))	6✔
138	})	6✔
139	.dealloc(\|iter_ptr\| unsafe {
140	drop(Box::from_raw(	1✔
141	iter_ptr.as_ptr::<HashSetIterator<'_, T>>()	1✔
142	as *mut HashSetIterator<'_, T>,	1✔
143	));
144	})	1✔
145	.build(),
146	)
147	.build()
148	},
149	)
150	.build(),
151	))
152	.build()
153	};
154	}
155
156	#[cfg(test)]
157	mod tests {
158	use alloc::string::String;
159	use std::collections::HashSet;
160	use std::hash::RandomState;
161
162	use super::*;
163
164	#[test]
165	fn test_hashset_type_params() {	1✔
166	// HashSet should have a type param for both its value type
167	// and its hasher state
168	let [type_param_1, type_param_2] = <HashSet<i32>>::SHAPE.type_params else {	1✔
UNCOV 169	panic!("HashSet<T> should have 2 type params")	×
170	};
171	assert_eq!(type_param_1.shape(), i32::SHAPE);	1✔
172	assert_eq!(type_param_2.shape(), RandomState::SHAPE);	1✔
173	}	1✔
174
175	#[test]
176	fn test_hashset_vtable_1_new_insert_iter_drop() -> eyre::Result<()> {	1✔
177	facet_testhelpers::setup();	1✔
178
179	let hashset_shape = <HashSet<String>>::SHAPE;	1✔
180	let hashset_def = hashset_shape	1✔
181	.def	1✔
182	.into_set()	1✔
183	.expect("HashSet<T> should have a set definition");	1✔
184
185	// Allocate memory for the HashSet
186	let hashset_uninit_ptr = hashset_shape.allocate()?;	1✔
187
188	// Create the HashSet with a capacity of 3
189	let hashset_ptr =	1✔
190	unsafe { (hashset_def.vtable.init_in_place_with_capacity_fn)(hashset_uninit_ptr, 3) };	1✔
191
192	// The HashSet is empty, so ensure its length is 0
193	let hashset_actual_length = unsafe { (hashset_def.vtable.len_fn)(hashset_ptr.as_const()) };	1✔
194	assert_eq!(hashset_actual_length, 0);	1✔
195
196	// 5 sample values to insert
197	let strings = ["foo", "bar", "bazz", "fizzbuzz", "fifth thing"];	1✔
198
199	// Insert the 5 values into the HashSet
200	let mut hashset_length = 0;	1✔
201	for string in strings {	6✔
202	// Create the value
203	let mut new_value = string.to_string();	5✔
204
205	// Insert the value
206	let did_insert = unsafe {	5✔
207	(hashset_def.vtable.insert_fn)(hashset_ptr, PtrMut::new(&raw mut new_value))	5✔
208	};
209
210	// The value now belongs to the HashSet, so forget it
211	core::mem::forget(new_value);	5✔
212
213	assert!(did_insert, "expected value to be inserted in the HashSet");	5✔
214
215	// Ensure the HashSet's length increased by 1
216	hashset_length += 1;	5✔
217	let hashset_actual_length =	5✔
218	unsafe { (hashset_def.vtable.len_fn)(hashset_ptr.as_const()) };	5✔
219	assert_eq!(hashset_actual_length, hashset_length);	5✔
220	}
221
222	// Insert the same 5 values again, ensuring they are deduplicated
223	for string in strings {	6✔
224	// Create the value
225	let mut new_value = string.to_string();	5✔
226
227	// Try to insert the value
228	let did_insert = unsafe {	5✔
229	(hashset_def.vtable.insert_fn)(hashset_ptr, PtrMut::new(&raw mut new_value))	5✔
230	};
231
232	// The value now belongs to the HashSet, so forget it
233	core::mem::forget(new_value);	5✔
234
235	assert!(	5✔
236	!did_insert,	5✔
UNCOV 237	"expected value to not be inserted in the HashSet"	×
238	);
239
240	// Ensure the HashSet's length did not increase
241	let hashset_actual_length =	5✔
242	unsafe { (hashset_def.vtable.len_fn)(hashset_ptr.as_const()) };	5✔
243	assert_eq!(hashset_actual_length, hashset_length);	5✔
244	}
245
246	// Create a new iterator over the HashSet
247	let iter_init_with_value_fn = hashset_def.vtable.iter_vtable.init_with_value.unwrap();	1✔
248	let hashset_iter_ptr = unsafe { iter_init_with_value_fn(hashset_ptr.as_const()) };	1✔
249
250	// Collect all the items from the HashSet's iterator
251	let mut iter_items = HashSet::<&str>::new();	1✔
252	loop {
253	// Get the next item from the iterator
254	let item_ptr = unsafe { (hashset_def.vtable.iter_vtable.next)(hashset_iter_ptr) };	6✔
255	let Some(item_ptr) = item_ptr else {	6✔
256	break;	1✔
257	};
258
259	let item = unsafe { item_ptr.get::<String>() };	5✔
260
261	// Insert the item into the set of items returned from the iterator
262	let did_insert = iter_items.insert(&**item);	5✔
263
264	assert!(did_insert, "HashSet iterator returned duplicate item");	5✔
265	}
266
267	// Deallocate the iterator
268	unsafe {	1✔
269	(hashset_def.vtable.iter_vtable.dealloc)(hashset_iter_ptr);	1✔
270	}	1✔
271
272	// Ensure the iterator returned all of the strings
273	assert_eq!(iter_items, strings.iter().copied().collect::<HashSet<_>>());	1✔
274
275	// Get the function pointer for dropping the HashSet
276	let drop_fn = hashset_shape	1✔
277	.vtable	1✔
278	.drop_in_place	1✔
279	.expect("HashSet<T> should have drop_in_place");	1✔
280
281	// Drop the HashSet in place
282	unsafe { drop_fn(hashset_ptr) };	1✔
283
284	// Deallocate the memory
285	unsafe { hashset_shape.deallocate_mut(hashset_ptr)? };	1✔
286
287	Ok(())	1✔
288	}	1✔
289	}

facet-rs / facet / 15134909761

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous