Soenneker.Atomics.ValueBools 4.0.44

Soenneker.Atomics.ValueBools

A one-byte, allocation-free atomic boolean struct using .NET 10 byte-sized Interlocked and Volatile operations (0 = false, 1 = true).

Install

dotnet add package Soenneker.Atomics.ValueBools

Usage

Keep the mutable struct in a field so every operation addresses the same storage:

using Soenneker.Atomics.ValueBools;

public sealed class Worker
{
    private ValueAtomicBool _stopping;

    public bool RequestStop() => _stopping.TrySetTrue();

    public bool IsStopping => _stopping.Read();
}

Do not expose it through a value-returning property, pass it by value, or store it in an API that copies structs. A copy contains independent atomic state; changes to the copy do not update the original field. Use the reference-type AtomicBool package when the state itself must be passed between objects.

Individual operations are atomic, but a read followed by a write is not one conditional operation. Use CompareAndSet, TrySetTrue, or TrySetFalse for state transitions.

Use VolatileWrite when a release write is sufficient, such as publishing a flag whose writers are already serialized. Write and the Value setter retain their interlocked exchanges and full memory fences.

The struct occupies one byte of managed storage, matching bool. Enclosing object sizes still depend on padding and alignment.

What you get

• ValueAtomicBool — A one-byte, allocation-free atomic boolean struct using .NET 10 byte-sized Interlocked and Volatile operations (0 = false, 1 = true).

API at a glance

Important behavior

• ValueAtomicBool: Reads establish acquire semantics and writes establish release semantics, making this type suitable for visibility signaling and safe publication between threads. This is a mutable struct intended for use as a private field or inline synchronization primitive. Avoid copying this type, returning it from properties, or using it through interfaces, as doing so will create independent copies of the atomic state.
• ValueAtomicBool.Write(value): This operation performs an interlocked exchange with a full memory fence.
• ValueAtomicBool.Value: The getter performs an atomic read with acquire semantics. The setter performs an interlocked exchange with a full memory fence.
• ValueAtomicBool.TrySetTrue(): This method performs a single compare-and-exchange operation and does not spin or retry.
• ValueAtomicBool.TrySetFalse(): This method performs a single compare-and-exchange operation and does not spin or retry.