Skip to content

Commit 9e66f2c

Browse files
committed
std: Update atomic documentation to remove 'mut'
It's all no longer necessary
1 parent 61622dd commit 9e66f2c

File tree

1 file changed

+23
-23
lines changed

1 file changed

+23
-23
lines changed

src/libstd/sync/atomics.rs

+23-23
Original file line numberDiff line numberDiff line change
@@ -288,15 +288,15 @@ impl AtomicBool {
288288
/// ```
289289
/// use std::sync::atomics::{AtomicBool, SeqCst};
290290
///
291-
/// let mut foo = AtomicBool::new(true);
291+
/// let foo = AtomicBool::new(true);
292292
/// assert_eq!(true, foo.fetch_and(false, SeqCst));
293293
/// assert_eq!(false, foo.load(SeqCst));
294294
///
295-
/// let mut foo = AtomicBool::new(true);
295+
/// let foo = AtomicBool::new(true);
296296
/// assert_eq!(true, foo.fetch_and(true, SeqCst));
297297
/// assert_eq!(true, foo.load(SeqCst));
298298
///
299-
/// let mut foo = AtomicBool::new(false);
299+
/// let foo = AtomicBool::new(false);
300300
/// assert_eq!(false, foo.fetch_and(false, SeqCst));
301301
/// assert_eq!(false, foo.load(SeqCst));
302302
/// ```
@@ -318,16 +318,16 @@ impl AtomicBool {
318318
/// ```
319319
/// use std::sync::atomics::{AtomicBool, SeqCst};
320320
///
321-
/// let mut foo = AtomicBool::new(true);
321+
/// let foo = AtomicBool::new(true);
322322
/// assert_eq!(true, foo.fetch_nand(false, SeqCst));
323323
/// assert_eq!(true, foo.load(SeqCst));
324324
///
325-
/// let mut foo = AtomicBool::new(true);
325+
/// let foo = AtomicBool::new(true);
326326
/// assert_eq!(true, foo.fetch_nand(true, SeqCst));
327327
/// assert_eq!(0, foo.load(SeqCst) as int);
328328
/// assert_eq!(false, foo.load(SeqCst));
329329
///
330-
/// let mut foo = AtomicBool::new(false);
330+
/// let foo = AtomicBool::new(false);
331331
/// assert_eq!(false, foo.fetch_nand(false, SeqCst));
332332
/// assert_eq!(true, foo.load(SeqCst));
333333
/// ```
@@ -349,15 +349,15 @@ impl AtomicBool {
349349
/// ```
350350
/// use std::sync::atomics::{AtomicBool, SeqCst};
351351
///
352-
/// let mut foo = AtomicBool::new(true);
352+
/// let foo = AtomicBool::new(true);
353353
/// assert_eq!(true, foo.fetch_or(false, SeqCst));
354354
/// assert_eq!(true, foo.load(SeqCst));
355355
///
356-
/// let mut foo = AtomicBool::new(true);
356+
/// let foo = AtomicBool::new(true);
357357
/// assert_eq!(true, foo.fetch_or(true, SeqCst));
358358
/// assert_eq!(true, foo.load(SeqCst));
359359
///
360-
/// let mut foo = AtomicBool::new(false);
360+
/// let foo = AtomicBool::new(false);
361361
/// assert_eq!(false, foo.fetch_or(false, SeqCst));
362362
/// assert_eq!(false, foo.load(SeqCst));
363363
/// ```
@@ -379,15 +379,15 @@ impl AtomicBool {
379379
/// ```
380380
/// use std::sync::atomics::{AtomicBool, SeqCst};
381381
///
382-
/// let mut foo = AtomicBool::new(true);
382+
/// let foo = AtomicBool::new(true);
383383
/// assert_eq!(true, foo.fetch_xor(false, SeqCst));
384384
/// assert_eq!(true, foo.load(SeqCst));
385385
///
386-
/// let mut foo = AtomicBool::new(true);
386+
/// let foo = AtomicBool::new(true);
387387
/// assert_eq!(true, foo.fetch_xor(true, SeqCst));
388388
/// assert_eq!(false, foo.load(SeqCst));
389389
///
390-
/// let mut foo = AtomicBool::new(false);
390+
/// let foo = AtomicBool::new(false);
391391
/// assert_eq!(false, foo.fetch_xor(false, SeqCst));
392392
/// assert_eq!(false, foo.load(SeqCst));
393393
/// ```
@@ -440,7 +440,7 @@ impl AtomicInt {
440440
/// ```
441441
/// use std::sync::atomics::{AtomicInt, SeqCst};
442442
///
443-
/// let mut foo = AtomicInt::new(0);
443+
/// let foo = AtomicInt::new(0);
444444
/// assert_eq!(0, foo.fetch_add(10, SeqCst));
445445
/// assert_eq!(10, foo.load(SeqCst));
446446
/// ```
@@ -456,7 +456,7 @@ impl AtomicInt {
456456
/// ```
457457
/// use std::sync::atomics::{AtomicInt, SeqCst};
458458
///
459-
/// let mut foo = AtomicInt::new(0);
459+
/// let foo = AtomicInt::new(0);
460460
/// assert_eq!(0, foo.fetch_sub(10, SeqCst));
461461
/// assert_eq!(-10, foo.load(SeqCst));
462462
/// ```
@@ -507,7 +507,7 @@ impl AtomicUint {
507507
/// ```
508508
/// use std::sync::atomics::{AtomicUint, SeqCst};
509509
///
510-
/// let mut foo = AtomicUint::new(0);
510+
/// let foo = AtomicUint::new(0);
511511
/// assert_eq!(0, foo.fetch_add(10, SeqCst));
512512
/// assert_eq!(10, foo.load(SeqCst));
513513
/// ```
@@ -523,7 +523,7 @@ impl AtomicUint {
523523
/// ```
524524
/// use std::sync::atomics::{AtomicUint, SeqCst};
525525
///
526-
/// let mut foo = AtomicUint::new(10);
526+
/// let foo = AtomicUint::new(10);
527527
/// assert_eq!(10, foo.fetch_sub(10, SeqCst));
528528
/// assert_eq!(0, foo.load(SeqCst));
529529
/// ```
@@ -790,7 +790,7 @@ mod test {
790790

791791
#[test]
792792
fn bool_() {
793-
let mut a = AtomicBool::new(false);
793+
let a = AtomicBool::new(false);
794794
assert_eq!(a.compare_and_swap(false, true, SeqCst), false);
795795
assert_eq!(a.compare_and_swap(false, true, SeqCst), true);
796796

@@ -800,13 +800,13 @@ mod test {
800800

801801
#[test]
802802
fn option_empty() {
803-
let mut option: AtomicOption<()> = AtomicOption::empty();
803+
let option: AtomicOption<()> = AtomicOption::empty();
804804
assert!(option.is_empty(SeqCst));
805805
}
806806

807807
#[test]
808808
fn option_swap() {
809-
let mut p = AtomicOption::new(~1);
809+
let p = AtomicOption::new(~1);
810810
let a = ~2;
811811

812812
let b = p.swap(a, SeqCst);
@@ -817,7 +817,7 @@ mod test {
817817

818818
#[test]
819819
fn option_take() {
820-
let mut p = AtomicOption::new(~1);
820+
let p = AtomicOption::new(~1);
821821

822822
assert_eq!(p.take(SeqCst), Some(~1));
823823
assert_eq!(p.take(SeqCst), None);
@@ -830,7 +830,7 @@ mod test {
830830

831831
#[test]
832832
fn option_fill() {
833-
let mut p = AtomicOption::new(~1);
833+
let p = AtomicOption::new(~1);
834834
assert!(p.fill(~2, SeqCst).is_some()); // should fail; shouldn't leak!
835835
assert_eq!(p.take(SeqCst), Some(~1));
836836

@@ -840,7 +840,7 @@ mod test {
840840

841841
#[test]
842842
fn bool_and() {
843-
let mut a = AtomicBool::new(true);
843+
let a = AtomicBool::new(true);
844844
assert_eq!(a.fetch_and(false, SeqCst),true);
845845
assert_eq!(a.load(SeqCst),false);
846846
}
@@ -867,7 +867,7 @@ mod test {
867867
let mut slot = 0u8;
868868
assert_eq!(super::atomic_compare_and_swap(&mut slot, 1, 2, SeqCst), 0);
869869

870-
let mut slot = 0u32;
870+
let slot = 0u32;
871871
assert_eq!(super::atomic_load(&slot, SeqCst), 0);
872872

873873
let mut slot = 0u64;

0 commit comments

Comments
 (0)