orx-pinned-vec 3.23.0

use super::refmap::RefMap;
use crate::PinnedVec;

/// Tests the pinned vector guarantee on removing elements from the end;
/// panics if the pinned vector implementation `P` does not satisfy the required condition.
///
/// Tested pinned element guarantee:
///
/// * **G2: pinned elements on removals from the end**. In this case, we are removing **m** ∈ [1, n] elements from the end of the vector leading to the final vector length of **n - m**. Pinned vector guarantees that memory locations of these remaining **n - m** elements do not change.
///   * *Some such example methods are **pop**, **truncate** or **clear**.*
///
/// # Panics
///
/// Panics if the pinned vector implementation `P` does not satisfy the abovementioned pinned elements guarantee.
pub fn pop<P: PinnedVec<usize>>(pinned_vec: P, max_allowed_test_len: usize) -> P {
    let mut vec = pinned_vec;
    vec.clear();

    let mut refmap = RefMap::new(200, max_allowed_test_len);

    for i in 0..max_allowed_test_len {
        vec.push(i);
        refmap.set_reference(&vec, i);
        refmap.validate_references(&vec);
    }

    for i in 0..max_allowed_test_len {
        let i = max_allowed_test_len - 1 - i;
        let value = vec.pop().expect("is some");
        assert_eq!(i, value);
        refmap.drop_reference(i);
        refmap.validate_references(&vec);
    }

    vec
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::pinned_vec_tests::testvec::TestVec;

    #[test]
    fn test_pop_empty() {
        let pinned_vec = TestVec::new(0);
        pop(pinned_vec, 0);
    }

    #[test]
    fn test_pop_small() {
        let capacity = 40;
        let pinned_vec = TestVec::new(capacity);
        pop(pinned_vec, capacity);
    }

    #[test]
    #[cfg(not(miri))]
    fn test_pop_medium() {
        let capacity = 256;
        let pinned_vec = TestVec::new(capacity);
        pop(pinned_vec, capacity);
    }
}