Struct ArcAtomicSignedCount 

pub struct ArcAtomicSignedCount { /* private fields */ }

Shared-owner wrapper around AtomicSignedCount.

This type is a convenience newtype for Arc<AtomicSignedCount>. Cloning an ArcAtomicSignedCount clones the shared owner handle, so all clones operate on the same underlying signed counter.

Example

use qubit_atomic::ArcAtomicSignedCount;

let counter = ArcAtomicSignedCount::zero();
let shared = counter.clone();

shared.sub(3);
assert_eq!(counter.get(), -3);
assert_eq!(counter.strong_count(), 2);

Implementations

impl ArcAtomicSignedCount

pub fn new(value: isize) -> Self

Creates a new shared signed atomic counter.

Parameters

• value - The initial counter value.

Returns

A shared signed counter wrapper initialized to value.

pub fn zero() -> Self

Creates a new shared signed counter initialized to zero.

Returns

A shared signed counter wrapper whose current value is zero.

pub fn from_count(counter: AtomicSignedCount) -> Self

Wraps an existing AtomicSignedCount in an Arc.

Parameters

• counter - The signed counter container to share.

Returns

A shared signed counter wrapper owning counter.

pub fn from_arc(inner: Arc<AtomicSignedCount>) -> Self

Wraps an existing shared signed atomic counter.

Parameters

• inner - The shared signed atomic counter to wrap.

Returns

A wrapper around inner.

pub fn as_arc(&self) -> &Arc<AtomicSignedCount>

Returns the underlying Arc without cloning it.

Returns

A shared reference to the underlying Arc<AtomicSignedCount>.

pub fn into_arc(self) -> Arc<AtomicSignedCount>

Consumes this wrapper and returns the underlying Arc.

Returns

The underlying Arc<AtomicSignedCount>.

pub fn strong_count(&self) -> usize

Returns the number of strong Arc owners.

Returns

The current strong reference count of the shared signed counter.

Methods from Deref<Target = AtomicSignedCount>

pub fn get(&self) -> isize

Gets the current counter value.

Returns

The current counter value.

Example

use qubit_atomic::AtomicSignedCount;

let counter = AtomicSignedCount::new(-7);
assert_eq!(counter.get(), -7);

pub fn is_zero(&self) -> bool

Returns whether the current counter value is zero.

Returns

true if the current value is zero, otherwise false.

Example

use qubit_atomic::AtomicSignedCount;

let counter = AtomicSignedCount::zero();
assert!(counter.is_zero());

pub fn is_positive(&self) -> bool

Returns whether the current counter value is greater than zero.

Returns

true if the current value is greater than zero, otherwise false.

Example

use qubit_atomic::AtomicSignedCount;

let counter = AtomicSignedCount::new(1);
assert!(counter.is_positive());

pub fn is_negative(&self) -> bool

Returns whether the current counter value is less than zero.

Returns

true if the current value is less than zero, otherwise false.

Example

use qubit_atomic::AtomicSignedCount;

let counter = AtomicSignedCount::new(-1);
assert!(counter.is_negative());

pub fn inc(&self) -> isize

Increments the counter by one and returns the new value.

Returns

The counter value after the increment.

Panics

Panics if the increment would overflow isize::MAX.

Example

use qubit_atomic::AtomicSignedCount;

let counter = AtomicSignedCount::zero();
assert_eq!(counter.inc(), 1);

pub fn dec(&self) -> isize

Decrements the counter by one and returns the new value.

Returns

The counter value after the decrement.

Panics

Panics if the decrement would underflow isize::MIN.

Example

use qubit_atomic::AtomicSignedCount;

let counter = AtomicSignedCount::zero();
assert_eq!(counter.dec(), -1);

pub fn add(&self, delta: isize) -> isize

Adds delta to the counter and returns the new value.

Parameters

• delta - The amount to add. It may be negative.

Returns

The counter value after the addition.

Panics

Panics if the addition would overflow or underflow the signed range.

Example

use qubit_atomic::AtomicSignedCount;

let counter = AtomicSignedCount::new(2);
assert_eq!(counter.add(-5), -3);

pub fn try_add(&self, delta: isize) -> Option<isize>

Tries to add delta to the counter.

Parameters

• delta - The amount to add. It may be negative.

Returns

Some(new_value) if the addition succeeds, or None if it would overflow or underflow the signed range. On None, the counter is left unchanged.

Example

use qubit_atomic::AtomicSignedCount;

let counter = AtomicSignedCount::new(-2);
assert_eq!(counter.try_add(5), Some(3));

pub fn sub(&self, delta: isize) -> isize

Subtracts delta from the counter and returns the new value.

Parameters

• delta - The amount to subtract. It may be negative.

Returns

The counter value after the subtraction.

Panics

Panics if the subtraction would overflow or underflow the signed range.

Example

use qubit_atomic::AtomicSignedCount;

let counter = AtomicSignedCount::new(2);
assert_eq!(counter.sub(5), -3);

pub fn try_sub(&self, delta: isize) -> Option<isize>

Tries to subtract delta from the counter.

Parameters

• delta - The amount to subtract. It may be negative.

Returns

Some(new_value) if the subtraction succeeds, or None if it would overflow or underflow the signed range. On None, the counter is left unchanged.

Example

use qubit_atomic::AtomicSignedCount;

let counter = AtomicSignedCount::new(2);
assert_eq!(counter.try_sub(5), Some(-3));

Trait Implementations

impl Clone for ArcAtomicSignedCount

fn clone(&self) -> Self

Clones the shared owner handle.

Returns

A new wrapper pointing to the same underlying signed atomic counter.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ArcAtomicSignedCount

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the current counter value and sharing state for debugging.

Parameters

• f - The formatter receiving the debug representation.

Returns

A formatting result from the formatter.

impl Default for ArcAtomicSignedCount

fn default() -> Self

Creates a zero-valued shared signed atomic counter.

Returns

A shared signed counter wrapper whose current value is zero.

impl Deref for ArcAtomicSignedCount

fn deref(&self) -> &Self::Target

Dereferences to the underlying AtomicSignedCount.

Returns

A shared reference to the signed atomic counter.

type Target = AtomicSignedCount

The resulting type after dereferencing.

impl Display for ArcAtomicSignedCount

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the current counter value with decimal display formatting.

Parameters

• f - The formatter receiving the displayed value.

Returns

A formatting result from the formatter.

impl From<Arc<AtomicSignedCount>> for ArcAtomicSignedCount

fn from(inner: Arc<AtomicSignedCount>) -> Self

Converts an existing shared signed atomic counter into its wrapper.

Parameters

• inner - The shared signed atomic counter to wrap.

Returns

A wrapper around inner.

impl From<AtomicSignedCount> for ArcAtomicSignedCount

fn from(counter: AtomicSignedCount) -> Self

Converts a signed atomic counter into a shared signed counter wrapper.

Parameters

• counter - The signed counter container to share.

Returns

A shared signed counter wrapper owning counter.

impl From<isize> for ArcAtomicSignedCount

fn from(value: isize) -> Self

Converts an initial counter value into a shared signed atomic counter.

Parameters

• value - The initial counter value.

Returns

A shared signed counter wrapper initialized to value.