qubit-atomic 0.9.0

User-friendly atomic operations wrapper providing JDK-like atomic API
Documentation
/*******************************************************************************
 *
 *    Copyright (c) 2025 - 2026.
 *    Haixing Hu, Qubit Co. Ltd.
 *
 *    All rights reserved.
 *
 ******************************************************************************/

use qubit_atomic::atomic::{
    Atomic,
    AtomicBool,
    AtomicF32,
    AtomicF64,
    AtomicI8,
    AtomicI32,
    AtomicI64,
    AtomicNumber,
    AtomicRef,
    AtomicU16,
    AtomicU64,
    AtomicUsize,
};
use std::sync::Arc;

// Test that all types implement the Atomic trait correctly
#[test]
fn test_atomic_trait_bool() {
    fn test_atomic<T: Atomic<Value = bool>>(atomic: &T) {
        atomic.store(true);
        assert!(atomic.load());
        let old = atomic.swap(false);
        assert!(old);
        assert!(!atomic.load());
    }

    let atomic = AtomicBool::new(false);
    test_atomic(&atomic);
}

#[test]
fn test_atomic_trait_integers() {
    fn test_atomic<T: Atomic<Value = i32>>(atomic: &T) {
        atomic.store(42);
        assert_eq!(atomic.load(), 42);
        let old = atomic.swap(100);
        assert_eq!(old, 42);
        assert_eq!(atomic.load(), 100);

        assert!(atomic.compare_set(100, 200).is_ok());
        assert_eq!(atomic.load(), 200);

        let prev = atomic.compare_exchange(200, 300);
        assert_eq!(prev, 200);
        assert_eq!(atomic.load(), 300);
    }

    let atomic = AtomicI32::new(0);
    test_atomic(&atomic);
}

#[test]
fn test_atomic_trait_floats() {
    fn test_atomic<T: Atomic<Value = f32>>(atomic: &T) {
        atomic.store(std::f32::consts::PI);
        assert!((atomic.load() - std::f32::consts::PI).abs() < 1e-6);
        let old = atomic.swap(2.71);
        assert!((old - std::f32::consts::PI).abs() < 1e-6);
    }

    let atomic = AtomicF32::new(0.0);
    test_atomic(&atomic);
}

#[test]
fn test_atomic_trait_ref() {
    fn test_atomic<T: Atomic<Value = Arc<i32>>>(atomic: &T) {
        atomic.store(Arc::new(42));
        assert_eq!(*atomic.load(), 42);
        let old = atomic.swap(Arc::new(100));
        assert_eq!(*old, 42);
    }

    let atomic = AtomicRef::new(Arc::new(0));
    test_atomic(&atomic);
}

// TODO: Rewrite after UpdatableAtomic removal
// #[test]
// fn test_updatable_atomic_trait_integers() {
//     // Test needs to be rewritten for fetch_update
// }

// TODO: Rewrite after UpdatableAtomic removal
// #[test]
// fn test_updatable_atomic_trait_floats() {
//     // Test needs to be rewritten for fetch_update
// }

// TODO: Rewrite after UpdatableAtomic removal
// #[test]
// fn test_updatable_atomic_trait_ref() {
//     // Test needs to be rewritten for fetch_update
// }

// Test Atomic trait through generic function
fn test_atomic_trait_via_generic<T: Atomic<Value = i32>>(atomic: &T) {
    // Test trait methods through generic constraint
    atomic.store(10);
    assert_eq!(atomic.load(), 10);

    let old = atomic.swap(20);
    assert_eq!(old, 10);
    assert_eq!(atomic.load(), 20);

    assert!(atomic.compare_set(20, 30).is_ok());
    assert_eq!(atomic.load(), 30);

    let prev = atomic.compare_exchange(30, 40);
    assert_eq!(prev, 30);
    assert_eq!(atomic.load(), 40);
}

// Test AtomicNumber trait through generic function
fn test_atomic_number_trait_via_generic<T: AtomicNumber<Value = i32>>(atomic: &T) {
    // Test trait methods through generic constraint
    // Note: fetch_inc/dec are not part of AtomicNumber trait, only fetch_add/sub/mul/div
    let old = atomic.fetch_add(1);
    assert_eq!(old, 0);

    let old = atomic.fetch_add(1);
    assert_eq!(old, 1);

    let old = atomic.fetch_sub(1);
    assert_eq!(old, 2);

    let old = atomic.fetch_sub(1);
    assert_eq!(old, 1);

    let old = atomic.fetch_add(10);
    assert_eq!(old, 0);

    let old = atomic.fetch_add(5);
    assert_eq!(old, 10); // returns old value
}

#[test]
fn test_all_traits_via_generic() {
    let atomic = AtomicI32::new(0);
    test_atomic_trait_via_generic(&atomic);

    let atomic = AtomicI32::new(0);
    test_atomic_trait_via_generic(&atomic);

    let atomic = AtomicI32::new(0);
    test_atomic_number_trait_via_generic(&atomic);
}

// Test AtomicNumber trait
#[test]
fn test_atomic_integer_trait_i8() {
    let atomic = AtomicI8::new(0);
    assert_eq!(atomic.fetch_inc(), 0); // returns old value
    assert_eq!(atomic.load(), 1);

    assert_eq!(atomic.fetch_add(5), 1); // returns old value
    assert_eq!(atomic.load(), 6);

    assert_eq!(atomic.fetch_dec(), 6); // returns old value
    assert_eq!(atomic.load(), 5);

    atomic.store(0b0101);
    atomic.fetch_and(0b0011);
    assert_eq!(atomic.load(), 0b0001);
}

#[test]
fn test_atomic_integer_trait_u16() {
    let atomic = AtomicU16::new(0);
    assert_eq!(atomic.fetch_inc(), 0); // returns old value
    assert_eq!(atomic.fetch_add(10), 1); // returns old value
    assert_eq!(atomic.fetch_sub(5), 11); // returns old value
    assert_eq!(atomic.load(), 6);

    atomic.fetch_max(20);
    assert_eq!(atomic.load(), 20);

    atomic.fetch_min(10);
    assert_eq!(atomic.load(), 10);
}

#[test]
fn test_atomic_integer_trait_i32() {
    let atomic = AtomicI32::new(0);
    // fetch_accumulate returns old value
    let old = atomic.fetch_accumulate(5, |a, b| a + b);
    assert_eq!(old, 0); // old value
    assert_eq!(atomic.load(), 5); // new value

    let old2 = atomic.fetch_accumulate(10, |a, b| a * b);
    assert_eq!(old2, 5); // old value
    assert_eq!(atomic.load(), 50); // new value
}

#[test]
fn test_atomic_integer_trait_i64() {
    let atomic = AtomicI64::new(0);
    atomic.fetch_inc();
    atomic.fetch_add(99);
    assert_eq!(atomic.load(), 100);

    atomic.fetch_or(0b1111);
    assert_eq!(atomic.load() & 0b1111, 0b1111);
}

#[test]
fn test_atomic_integer_trait_usize() {
    let atomic = AtomicUsize::new(0);
    for _ in 0..10 {
        atomic.fetch_inc();
    }
    assert_eq!(atomic.load(), 10);

    atomic.fetch_xor(0b1010);
    // Result depends on platform, just check it doesn't panic
    let _ = atomic.load();
}

// Test that all integer types implement all three traits
#[test]
fn test_all_traits_i32() {
    fn test_all<T>(atomic: &T)
    where
        T: Atomic<Value = i32> + AtomicNumber<Value = i32>,
    {
        // Atomic trait
        atomic.store(10);
        assert_eq!(atomic.load(), 10);

        let _old = atomic.fetch_update(|x| x + 5);
        assert_eq!(atomic.load(), 15);

        // AtomicNumber trait
        let _old = atomic.fetch_add(1);
        assert_eq!(atomic.load(), 16);
    }

    let atomic = AtomicI32::new(0);
    test_all(&atomic);
}

// Test trait object usage
// NOTE: Atomic trait is no longer dyn compatible due to fetch_update<F>
// #[test]
// fn test_trait_object_atomic() {
//     // Trait objects cannot be used with Atomic trait anymore
// }

// Test Send and Sync traits
#[test]
fn test_send_sync() {
    fn assert_send<T: Send>() {}
    fn assert_sync<T: Sync>() {}

    assert_send::<AtomicBool>();
    assert_sync::<AtomicBool>();

    assert_send::<AtomicI32>();
    assert_sync::<AtomicI32>();

    assert_send::<AtomicU64>();
    assert_sync::<AtomicU64>();

    assert_send::<AtomicF32>();
    assert_sync::<AtomicF32>();

    assert_send::<AtomicF64>();
    assert_sync::<AtomicF64>();

    assert_send::<AtomicRef<i32>>();
    assert_sync::<AtomicRef<i32>>();
}

// Test Default trait
#[test]
fn test_default_trait() {
    let atomic_bool = AtomicBool::default();
    assert!(!atomic_bool.load());

    let atomic_i32 = AtomicI32::default();
    assert_eq!(atomic_i32.load(), 0);

    let atomic_f64 = AtomicF64::default();
    assert_eq!(atomic_f64.load(), 0.0);
}

// Test From trait
#[test]
fn test_from_trait() {
    let atomic_bool = AtomicBool::from(true);
    assert!(atomic_bool.load());

    let atomic_i32 = AtomicI32::from(42);
    assert_eq!(atomic_i32.load(), 42);

    let atomic_f32 = AtomicF32::from(std::f32::consts::PI);
    assert!((atomic_f32.load() - std::f32::consts::PI).abs() < 1e-6);
}

// Test Debug and Display traits
#[test]
fn test_debug_display_traits() {
    let atomic_bool = AtomicBool::new(true);
    assert!(format!("{:?}", atomic_bool).contains("true"));
    assert_eq!(format!("{}", atomic_bool), "true");

    let atomic_i32 = AtomicI32::new(42);
    assert!(format!("{:?}", atomic_i32).contains("42"));
    assert_eq!(format!("{}", atomic_i32), "42");

    let atomic_f64 = AtomicF64::new(std::f64::consts::PI);
    assert!(format!("{:?}", atomic_f64).contains("3.14"));
    assert!(format!("{}", atomic_f64).contains("3.14"));
}