swap dequeue and push

src/lib.rs

@@ -972,6 +972,7 @@ mod tests {
 
     #[test]
     fn run_test_skip() {
+        #[allow(deprecated)]
         fn test_skip(mut b: impl RingBuffer<i32>) {
             b.push(0);
             b.push(1);
@@ -991,6 +992,7 @@ mod tests {
 
     #[test]
     fn run_test_skip_2() {
+        #[allow(deprecated)]
         fn test_skip2(mut rb: impl RingBuffer<i32>) {
             rb.skip();
             rb.skip();

src/ringbuffer_trait.rs

@@ -75,20 +75,25 @@ pub unsafe trait RingBuffer<T>:
     #[doc(hidden)]
     unsafe fn ptr_buffer_size(rb: *const Self) -> usize;
 
-    /// Pushes a value onto the buffer. Cycles around if capacity is reached.
-    fn push(&mut self, value: T);
-
-    /// alias for [`push`](RingBuffer::push), forming a more natural counterpart to [`dequeue`](RingBuffer::dequeue)
-    fn enqueue(&mut self, value: T) {
-        self.push(value);
+    /// Alias for [`enqueue`](RingBuffer::enqueue)
+    fn push(&mut self, value: T) {
+        self.enqueue(value);
     }
 
+    /// Adds a value onto the buffer.
+    ///
+    /// Cycles around if capacity is reached.
+    /// Forms a more natural counterpart to [`dequeue`](RingBuffer::dequeue).
+    /// An alias is provided with [`push`](RingBuffer::push).
+    fn enqueue(&mut self, value: T);
+
     /// dequeues the top item off the ringbuffer, and moves this item out.
     fn dequeue(&mut self) -> Option<T>;
 
     /// dequeues the top item off the queue, but does not return it. Instead it is dropped.
     /// If the ringbuffer is empty, this function is a nop.
     #[inline]
+    #[deprecated = "use dequeue instead"]
     fn skip(&mut self) {
         let _ = self.dequeue();
     }

src/with_alloc/alloc_ringbuffer.rs

@@ -229,7 +229,7 @@ unsafe impl<T> RingBuffer<T> for AllocRingBuffer<T> {
     impl_ringbuffer!(readptr, writeptr);
 
     #[inline]
-    fn push(&mut self, value: T) {
+    fn enqueue(&mut self, value: T) {
         if self.is_full() {
             // mask with and is allowed here because size is always a power of two
             let previous_value =

src/with_alloc/vecdeque.rs

@@ -186,7 +186,7 @@ unsafe impl<T> RingBuffer<T> for GrowableAllocRingBuffer<T> {
         self.pop_front()
     }
 
-    fn push(&mut self, value: T) {
+    fn enqueue(&mut self, value: T) {
         self.push_back(value);
     }
 

src/with_const_generics.rs

@@ -265,7 +265,7 @@ unsafe impl<T, const CAP: usize> RingBuffer<T> for ConstGenericRingBuffer<T, CAP
     impl_ringbuffer!(readptr, writeptr);
 
     #[inline]
-    fn push(&mut self, value: T) {
+    fn enqueue(&mut self, value: T) {
         if self.is_full() {
             let previous_value = mem::replace(
                 &mut self.buf[crate::mask_modulo(CAP, self.readptr)],