[PATCH v1] rust: sync: atomic: Add example for Atomic::get_mut

[PATCH v1] rust: sync: atomic: Add example for Atomic::get_mut

[FUJITA Tomonori]

From: FUJITA Tomonori <fujita.tomonori@gmail.com>

Add an example for Atomic::get_mut(). No functional change.

Signed-off-by: FUJITA Tomonori <fujita.tomonori@gmail.com>
---
 rust/kernel/sync/atomic.rs | 11 +++++++++++
 1 file changed, 11 insertions(+)

diff --git a/rust/kernel/sync/atomic.rs b/rust/kernel/sync/atomic.rs
index 4aebeacb961a..d44550adb0d4 100644
--- a/rust/kernel/sync/atomic.rs
+++ b/rust/kernel/sync/atomic.rs
@@ -235,6 +235,17 @@ pub const fn as_ptr(&self) -> *mut T {
     /// Returns a mutable reference to the underlying atomic `T`.
     ///
     /// This is safe because the mutable reference of the atomic `T` guarantees exclusive access.
+    ///
+    /// # Examples
+    ///
+    /// ```
+    /// use kernel::sync::atomic::{Atomic, Relaxed};
+    ///
+    /// let mut atomic_val = Atomic::new(0u32);
+    /// let val_mut = atomic_val.get_mut();
+    /// *val_mut = 101;
+    /// assert_eq!(101, atomic_val.load(Relaxed));
+    /// ```
     pub fn get_mut(&mut self) -> &mut T {
         // CAST: `T` and `T::Repr` has the same size and alignment per the safety requirement of
         // `AtomicType`, and per the type invariants `self.0` is a valid `T`, therefore the casting

base-commit: 6583920e15fc567109e1c64ca58c917f52f40736
-- 
2.43.0

Re: [PATCH v1] rust: sync: atomic: Add example for Atomic::get_mut

[Gary Guo]

On Wed Jan 28, 2026 at 12:33 PM GMT, FUJITA Tomonori wrote:
> From: FUJITA Tomonori <fujita.tomonori@gmail.com>
> 
> Add an example for Atomic::get_mut(). No functional change.
> 
> Signed-off-by: FUJITA Tomonori <fujita.tomonori@gmail.com>

Reviewed-by: Gary Guo <gary@garyguo.net>

> ---
>  rust/kernel/sync/atomic.rs | 11 +++++++++++
>  1 file changed, 11 insertions(+)

Re: [PATCH v1] rust: sync: atomic: Add example for Atomic::get_mut

[Alice Ryhl]

On Wed, Jan 28, 2026 at 09:33:13PM +0900, FUJITA Tomonori wrote:
> From: FUJITA Tomonori <fujita.tomonori@gmail.com>
> 
> Add an example for Atomic::get_mut(). No functional change.
> 
> Signed-off-by: FUJITA Tomonori <fujita.tomonori@gmail.com>

Reviewed-by: Alice Ryhl <aliceryhl@google.com>

Re: [PATCH v1] rust: sync: atomic: Add example for Atomic::get_mut

[Boqun Feng]

On Wed, Jan 28, 2026 at 09:33:13PM +0900, FUJITA Tomonori wrote:
> From: FUJITA Tomonori <fujita.tomonori@gmail.com>
> 
> Add an example for Atomic::get_mut(). No functional change.
> 
> Signed-off-by: FUJITA Tomonori <fujita.tomonori@gmail.com>

Queued! Thank you all!

Regards,
Boqun