std::sync::atomic::AtomicBool — Rust struct

What `AtomicBool` does

AtomicBool is a struct exposed by the std::sync::atomic module of the Rust standard library. It is part of the public, stable API and you can rely on it from any edition of Rust.

As a struct, AtomicBool bundles related fields into a single named record with a known layout. Each field has a fixed type and offset, so the size of an instance is the sum of its field sizes plus alignment padding. Construction follows ordinary Rust ownership rules: each owned field must itself be constructed or moved before the struct is well-formed, and the compiler will refuse to leave any field uninitialised. The full canonical path is std::sync::atomic::AtomicBool; bring it into scope with use std::sync::atomic::AtomicBool; or refer to it by its full path.

When to use it

Reach for AtomicBool whenever you need a value with the fields and methods documented for std::sync::atomic::AtomicBool. Use a reference (`&AtomicBool`) in function parameters by default; only take ownership when the function must consume or store the value.

Annotated examples

Constructing and using AtomicBool

use std::sync::atomic::AtomicBool;

fn demo() {
    // Construct a AtomicBool value. The exact constructor depends on the type;
    // look for `new`, `default`, `from`, or `with_*` associated functions in
    // the documentation. For types with no public constructor, you typically
    // receive a AtomicBool by calling another std function that returns one.
    let value: AtomicBool = Default::default();

    // Most std structs implement Debug, so {:?} works for inspection.
    println!("{:?}", value);
}

The first thing you do with any new struct is figure out how to construct one — `new`, `default`, `from`, or returned from another function. The std::sync::atomic::AtomicBool reference shows every available constructor.

For deeper background, see the canonical Rust patterns reference for the broader context behind this section.

Passing AtomicBool into a function

use std::sync::atomic::AtomicBool;

// Take AtomicBool by reference when you only need to read it — this avoids
// any clone or move and lets the caller keep using their value.
fn observe(value: &AtomicBool) {
    println!("{:?}", value);
}

// Take AtomicBool by &mut when you need to mutate it in place.
fn update(value: &mut AtomicBool) {
    *value = Default::default();
}

// Take AtomicBool by value only when you need to consume it.
fn consume(value: AtomicBool) -> AtomicBool {
    value
}

The borrow / mutate / consume distinction is the most important Rust ergonomic to internalise. Default to `&AtomicBool`, escalate to `&mut AtomicBool` when you must mutate, and only take ownership when you must.

Common pitfalls

Avoid cloning a AtomicBool unnecessarily — pass it by `&AtomicBool` whenever read-only access is enough. If the struct holds heap allocations, every clone duplicates that memory. Hold no more than one `&mut` borrow at a time; the compiler will refuse to compile aliased mutable references.

For deeper background, see an in-depth Rust idioms cheat sheet for the broader context behind this section.

Performance & threading notes

Stack-allocated by default. Heap allocation only happens if a field is itself heap-allocated (Vec, String, Box). Cloning copies every field; for read access pass by reference. Send / Sync are automatically derived if every field is Send / Sync.

What AtomicBool does