zenoh-collections 1.10.2

//
// Copyright (c) 2023 ZettaScale Technology
//
// This program and the accompanying materials are made available under the
// terms of the Eclipse Public License 2.0 which is available at
// http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
// which is available at https://www.apache.org/licenses/LICENSE-2.0.
//
// SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
//
// Contributors:
//   ZettaScale Zenoh Team, <zenoh@zettascale.tech>
//
use std::collections::VecDeque;

#[derive(Debug)]
pub struct RingBuffer<T> {
    capacity: usize,
    len: usize,
    buffer: VecDeque<T>,
}

impl<T> RingBuffer<T> {
    #[must_use]
    pub fn new(capacity: usize) -> RingBuffer<T> {
        let buffer = VecDeque::<T>::with_capacity(capacity);
        RingBuffer {
            capacity,
            len: 0,
            buffer,
        }
    }

    #[inline]
    pub fn push(&mut self, elem: T) -> Option<T> {
        if self.len < self.capacity {
            self.buffer.push_back(elem);
            self.len += 1;
            return None;
        }
        Some(elem)
    }

    #[inline]
    pub fn push_force(&mut self, elem: T) -> Option<T> {
        self.push(elem).and_then(|elem| {
            let ret = self.buffer.pop_front();
            self.buffer.push_back(elem);
            ret
        })
    }

    #[inline]
    pub fn pull(&mut self) -> Option<T> {
        let x = self.buffer.pop_front();
        if x.is_some() {
            self.len -= 1;
        }
        x
    }

    #[allow(dead_code)]
    #[inline]
    #[must_use]
    pub fn is_empty(&self) -> bool {
        self.buffer.is_empty()
    }

    #[inline]
    #[must_use]
    pub fn is_full(&self) -> bool {
        self.len() == self.capacity()
    }

    #[inline]
    #[must_use]
    pub fn len(&self) -> usize {
        self.len
    }

    #[inline]
    #[must_use]
    pub fn capacity(&self) -> usize {
        self.capacity
    }
}