LPGhatguy / thunderdome

Arena type inspired by generational-arena
Apache License 2.0
197 stars 15 forks source link

Exposing iterators via `iter` module #24

Closed toyboot4e closed 2 years ago

toyboot4e commented 3 years ago

Current documentation:

th-1

Suggestion:

th-2

Code:

pub mod iters {
    //! Iterator types

    pub use crate::drain::Drain;
    pub use crate::drain_filter::DrainFilter;
    pub use crate::into_iter::IntoIter;
    pub use crate::iter::Iter;
    pub use crate::iter_mut::IterMut;
    pub use crate::values::ValuesIter;
    pub use crate::values_mut::ValuesIterMut;
}

Feel free to skip this idea. Thank you :)

LPGhatguy commented 3 years ago

This would be a good organizational change. Should we call this module iters or iter?

toyboot4e commented 3 years ago

Ah, I changed my mind: std hides iterators in collection_name module (c.f. std::collections). So I like arena module for hiding iterators, but please choose what you like :)

LPGhatguy commented 3 years ago

I feel meh on arena, since this whole crate is just about this one arena type, heh. I think my vote is iter!

toyboot4e commented 3 years ago

That makes sense to me! Now I like iter module :)