export sizes

src/lib.rs

@@ -77,6 +77,8 @@ mod with_alloc;
 #[cfg(feature = "alloc")]
 pub use with_alloc::alloc_ringbuffer::AllocRingBuffer;
 #[cfg(feature = "alloc")]
+pub use with_alloc::alloc_ringbuffer::{NonPowerOfTwo, PowerOfTwo, RingbufferSize};
+#[cfg(feature = "alloc")]
 pub use with_alloc::vecdeque::GrowableAllocRingBuffer;
 
 mod with_const_generics;

src/with_alloc/alloc_ringbuffer.rs

@@ -10,9 +10,13 @@ use core::marker::PhantomData;
 use core::ptr;
 
 #[derive(Debug, Copy, Clone)]
+/// Represents that an alloc ringbuffer must have a size that's a power of two.
+/// This means slightly more optimizations can be performed, but it is less flexible.
 pub struct PowerOfTwo;
 
 #[derive(Debug, Copy, Clone)]
+/// Represents that an alloc ringbuffer can have a size that's not a power of two.
+/// This means slightly fewer optimizations can be performed, but it is more flexible.
 pub struct NonPowerOfTwo;
 mod private {
     use crate::with_alloc::alloc_ringbuffer::{NonPowerOfTwo, PowerOfTwo};
@@ -23,8 +27,13 @@ mod private {
     impl Sealed for NonPowerOfTwo {}
 }
 
+/// Sealed trait with two implementations that represent the kinds of sizes a ringbuffer can have
+/// *[`NonPowerOfTwo`]
+/// *[`PowerOfTwo`]
 pub trait RingbufferSize: private::Sealed {
+    /// the mask function to use for wrapping indices in the ringbuffer
     fn mask(cap: usize, index: usize) -> usize;
+    /// true in [`PowerOfTwo`], false in [`NonPowerOfTwo`]
     fn must_be_power_of_two() -> bool;
 }