Skip to content

Commit f58c65a

Browse files
authored
doc: Added commas where needed
1 parent d0227c6 commit f58c65a

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

library/core/src/ptr/mod.rs

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@
237237
//! pointer. For code which *does* cast a usize to a pointer, the scope of the change depends
238238
//! on exactly what you're doing.
239239
//!
240-
//! In general you just need to make sure that if you want to convert a usize address to a
240+
//! In general, you just need to make sure that if you want to convert a usize address to a
241241
//! pointer and then use that pointer to read/write memory, you need to keep around a pointer
242242
//! that has sufficient provenance to perform that read/write itself. In this way all of your
243243
//! casts from an address to a pointer are essentially just applying offsets/indexing.
@@ -309,7 +309,7 @@
309309
//! i.e. the usual "ZSTs are fake, do what you want" rules apply *but* this only applies
310310
//! for actual forgery (integers cast to pointers). If you borrow some struct's field
311311
//! that *happens* to be zero-sized, the resulting pointer will have provenance tied to
312-
//! that allocation and it will still get invalidated if the allocation gets deallocated.
312+
//! that allocation, and it will still get invalidated if the allocation gets deallocated.
313313
//! In the future we may introduce an API to make such a forged allocation explicit.
314314
//!
315315
//! * [`wrapping_offset`][] a pointer outside its provenance. This includes pointers
@@ -698,7 +698,7 @@ pub const fn dangling_mut<T>() -> *mut T {
698698
///
699699
/// If there is no 'exposed' provenance that justifies the way this pointer will be used,
700700
/// the program has undefined behavior. In particular, the aliasing rules still apply: pointers
701-
/// and references that have been invalidated due to aliasing accesses cannot be used any more,
701+
/// and references that have been invalidated due to aliasing accesses cannot be used anymore,
702702
/// even if they have been exposed!
703703
///
704704
/// Note that there is no algorithm that decides which provenance will be used. You can think of this
@@ -728,8 +728,8 @@ pub const fn dangling_mut<T>() -> *mut T {
728728
#[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
729729
#[allow(fuzzy_provenance_casts)] // this *is* the explicit provenance API one should use instead
730730
pub fn with_exposed_provenance<T>(addr: usize) -> *const T
731-
where
732-
T: Sized,
731+
where
732+
T: Sized,
733733
{
734734
// FIXME(strict_provenance_magic): I am magic and should be a compiler intrinsic.
735735
addr as *const T
@@ -768,8 +768,8 @@ where
768768
#[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
769769
#[allow(fuzzy_provenance_casts)] // this *is* the explicit provenance API one should use instead
770770
pub fn with_exposed_provenance_mut<T>(addr: usize) -> *mut T
771-
where
772-
T: Sized,
771+
where
772+
T: Sized,
773773
{
774774
// FIXME(strict_provenance_magic): I am magic and should be a compiler intrinsic.
775775
addr as *mut T
@@ -1067,7 +1067,7 @@ pub const unsafe fn swap_nonoverlapping<T>(x: *mut T, y: *mut T, count: usize) {
10671067
// because we don't want to pessimize things like slices of SIMD vectors.)
10681068
if mem::align_of::<T>() <= mem::size_of::<usize>()
10691069
&& (!mem::size_of::<T>().is_power_of_two()
1070-
|| mem::size_of::<T>() > mem::size_of::<usize>() * 2)
1070+
|| mem::size_of::<T>() > mem::size_of::<usize>() * 2)
10711071
{
10721072
attempt_swap_as_chunks!(usize);
10731073
attempt_swap_as_chunks!(u8);
@@ -1097,7 +1097,7 @@ const unsafe fn swap_nonoverlapping_simple_untyped<T>(x: *mut T, y: *mut T, coun
10971097
// If we end up here, it's because we're using a simple type -- like
10981098
// a small power-of-two-sized thing -- or a special type with particularly
10991099
// large alignment, particularly SIMD types.
1100-
// Thus we're fine just reading-and-writing it, as either it's small
1100+
// Thus, we're fine just reading-and-writing it, as either it's small
11011101
// and that works well anyway or it's special and the type's author
11021102
// presumably wanted things to be done in the larger chunk.
11031103

@@ -1290,7 +1290,7 @@ pub const unsafe fn read<T>(src: *const T) -> T {
12901290
// provides enough information to know that this is a typed operation.
12911291

12921292
// However, as of March 2023 the compiler was not capable of taking advantage
1293-
// of that information. Thus the implementation here switched to an intrinsic,
1293+
// of that information. Thus, the implementation here switched to an intrinsic,
12941294
// which lowers to `_0 = *src` in MIR, to address a few issues:
12951295
//
12961296
// - Using `MaybeUninit::assume_init` after a `copy_nonoverlapping` was not
@@ -1405,9 +1405,9 @@ pub const unsafe fn read<T>(src: *const T) -> T {
14051405
#[stable(feature = "ptr_unaligned", since = "1.17.0")]
14061406
#[rustc_const_stable(feature = "const_ptr_read", since = "1.71.0")]
14071407
#[rustc_allow_const_fn_unstable(
1408-
const_mut_refs,
1409-
const_maybe_uninit_as_mut_ptr,
1410-
const_intrinsic_copy
1408+
const_mut_refs,
1409+
const_maybe_uninit_as_mut_ptr,
1410+
const_intrinsic_copy
14111411
)]
14121412
#[cfg_attr(miri, track_caller)] // even without panics, this helps for Miri backtraces
14131413
#[rustc_diagnostic_item = "ptr_read_unaligned"]
@@ -1570,7 +1570,7 @@ pub const unsafe fn write<T>(dst: *mut T, src: T) {
15701570
/// As a result, using `&packed.unaligned as *const FieldType` causes immediate
15711571
/// *undefined behavior* in your program.
15721572
///
1573-
/// Instead you must use the [`ptr::addr_of_mut!`](addr_of_mut)
1573+
/// Instead, you must use the [`ptr::addr_of_mut!`](addr_of_mut)
15741574
/// macro to create the pointer. You may use that returned pointer together with
15751575
/// this function.
15761576
///
@@ -2205,7 +2205,7 @@ impl<F: FnPtr> fmt::Debug for F {
22052205
#[rustc_macro_transparency = "semitransparent"]
22062206
#[allow_internal_unstable(raw_ref_op)]
22072207
pub macro addr_of($place:expr) {
2208-
&raw const $place
2208+
&raw const $place
22092209
}
22102210

22112211
/// Create a `mut` raw pointer to a place, without creating an intermediate reference.
@@ -2293,5 +2293,5 @@ pub macro addr_of($place:expr) {
22932293
#[rustc_macro_transparency = "semitransparent"]
22942294
#[allow_internal_unstable(raw_ref_op)]
22952295
pub macro addr_of_mut($place:expr) {
2296-
&raw mut $place
2296+
&raw mut $place
22972297
}

0 commit comments

Comments
 (0)