1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773
use super::*;
use crate::cmp::Ordering::{self, Equal, Greater, Less};
use crate::intrinsics::{self, const_eval_select};
use crate::mem;
use crate::slice::{self, SliceIndex};
impl<T: ?Sized> *const T {
/// 如果指针为空,则返回 `true`。
///
/// 请注意,未定义大小的类型具有许多可能的空指针,因为仅考虑原始数据指针,而不考虑其长度,vtable 等。
/// 因此,两个为空的指针可能仍不能相互比较相等。
///
/// ## 常量评估期间的行为
///
/// 在 const 评估期间使用此函数时,对于在运行时结果为空的指针,它可能返回 `false`。
/// 具体来说,当指向某个内存的指针超出其范围的偏移量 (使结果指针为空) 时,函数仍将返回 `false`。
///
/// CTFE 无法知道该内存的绝对位置,因此我们无法确定指针是否为空。
///
/// # Examples
///
/// ```
/// let s: &str = "Follow the rabbit";
/// let ptr: *const u8 = s.as_ptr();
/// assert!(!ptr.is_null());
/// ```
///
///
///
///
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_const_unstable(feature = "const_ptr_is_null", issue = "74939")]
#[inline]
pub const fn is_null(self) -> bool {
#[inline]
fn runtime_impl(ptr: *const u8) -> bool {
ptr.addr() == 0
}
#[inline]
const fn const_impl(ptr: *const u8) -> bool {
// 通过对瘦指针进行强制转换进行比较,因此胖指针仅考虑其 "data" 部分是否为空。
//
match (ptr).guaranteed_eq(null_mut()) {
None => false,
Some(res) => res,
}
}
// SAFETY: 这两个版本在运行时是等效的。
unsafe { const_eval_select((self as *const u8,), const_impl, runtime_impl) }
}
/// 强制转换为另一种类型的指针。
#[stable(feature = "ptr_cast", since = "1.38.0")]
#[rustc_const_stable(feature = "const_ptr_cast", since = "1.38.0")]
#[inline(always)]
pub const fn cast<U>(self) -> *const U {
self as _
}
/// 在另一种类型的新指针中使用指针值。
///
/// 如果 `meta` 是指向未定义大小类型的 (fat) 指针,此操作将忽略指针部分,而对于指向大小类型的 (thin) 指针,这与简单强制转换具有相同的效果。
///
/// 生成的指针将具有 `self` 的来源,即,对于胖指针,此操作在语义上与创建数据指针值为 `self` 但元数据为 `meta` 的新胖指针相同。
///
///
/// # Examples
///
/// 此函数主要用于允许对潜在的胖指针进行按字节指针算术运算:
///
/// ```
/// #![feature(set_ptr_value)]
/// # use core::fmt::Debug;
/// let arr: [i32; 3] = [1, 2, 3];
/// let mut ptr = arr.as_ptr() as *const dyn Debug;
/// let thin = ptr as *const u8;
/// unsafe {
/// ptr = thin.add(8).with_metadata_of(ptr);
/// # assert_eq!(*(ptr as *const i32), 3);
/// println!("{:?}", &*ptr); // 将打印 "3"
/// }
/// ```
///
///
///
///
///
#[unstable(feature = "set_ptr_value", issue = "75091")]
#[rustc_const_unstable(feature = "set_ptr_value", issue = "75091")]
#[must_use = "returns a new pointer rather than modifying its argument"]
#[inline]
pub const fn with_metadata_of<U>(self, meta: *const U) -> *const U
where
U: ?Sized,
{
from_raw_parts::<U>(self as *const (), metadata(meta))
}
/// 更改常量而不更改类型。
///
/// 这比 `as` 安全一点,因为如果重构代码,它不会默默地改变类型。
///
#[stable(feature = "ptr_const_cast", since = "1.65.0")]
#[rustc_const_stable(feature = "ptr_const_cast", since = "1.65.0")]
#[inline(always)]
pub const fn cast_mut(self) -> *mut T {
self as _
}
/// 将指针强制转换为原始位。
///
/// 这等效于 `as usize`,但更具体以增强可读性。
/// 相反的方法是 [`from_bits`](#method.from_bits)。
///
/// 特别是,`*p as usize` 和 `p as usize` 都会编译指向数字类型的指针,但做的事情却截然不同,因此使用它有助于强调读取位是有意的。
///
///
/// # Examples
///
/// ```
/// #![feature(ptr_to_from_bits)]
/// # #[cfg(not(miri))] { // doctest 不适用于严格的出处
/// let array = [13, 42];
/// let p0: *const i32 = &array[0];
/// assert_eq!(<*const _>::from_bits(p0.to_bits()), p0);
/// let p1: *const i32 = &array[1];
/// assert_eq!(p1.to_bits() - p0.to_bits(), 4);
/// # }
/// ```
///
#[unstable(feature = "ptr_to_from_bits", issue = "91126")]
#[deprecated(
since = "1.67.0",
note = "replaced by the `expose_addr` method, or update your code \
to follow the strict provenance rules using its APIs"
)]
#[inline(always)]
pub fn to_bits(self) -> usize
where
T: Sized,
{
self as usize
}
/// 从其原始位创建一个指针。
///
/// 这等效于 `as *const T`,但更具体地说是为了增强可读性。
/// 相反的方法是 [`to_bits`](#method.to_bits)。
///
/// # Examples
///
/// ```
/// #![feature(ptr_to_from_bits)]
/// # #[cfg(not(miri))] { // doctest 不适用于严格的出处
/// use std::ptr::NonNull;
/// let dangling: *const u8 = NonNull::dangling().as_ptr();
/// assert_eq!(<*const u8>::from_bits(1), dangling);
/// # }
/// ```
#[unstable(feature = "ptr_to_from_bits", issue = "91126")]
#[deprecated(
since = "1.67.0",
note = "replaced by the `ptr::from_exposed_addr` function, or update \
your code to follow the strict provenance rules using its APIs"
)]
#[allow(fuzzy_provenance_casts)] // 这是一个不稳定且半弃用的转换函数
#[inline(always)]
pub fn from_bits(bits: usize) -> Self
where
T: Sized,
{
bits as Self
}
/// 获取指针的 "address" 部分。
///
/// 这类似于 `self as usize`,它在语义上丢弃了*provenance* 和*address-space* 信息。
/// 但是,与 `self as usize` 不同,将返回的地址转换回指针会产生 [`invalid`][],这对于解引用来说是未定义的行为。
/// 要正确恢复丢失的信息并获得可解引用的指针,请使用 [`with_addr`][pointer::with_addr] 或 [`map_addr`][pointer::map_addr]。
///
/// 如果由于无法保留具有所需出处的指针而无法使用这些 API,请改用 [`expose_addr`][pointer::expose_addr] 和 [`from_exposed_addr`][from_exposed_addr]。
///
/// 但是,请注意,这会降低您的代码的可移植性,并且不太适合用于检查是否符合 Rust 内存模型的工具。
///
/// 在大多数平台上,这将产生一个与原始指针具有相同字节的值,因为所有字节都专用于描述地址。
/// 需要在指针中存储附加信息的平台可以执行表示的改变,以产生仅包含指针的地址部分的值。
/// 这意味着什么取决于平台来定义。
///
/// 此 API 及其声明的语义是 Strict Provenance 实验的一部分,因此可能会在 future 中发生变化 (包括可能削弱这一点,使其完全等同于 `self as usize`)。
/// 有关详细信息,请参见 [[模块文档][crate::ptr]。
///
///
///
///
///
///
///
#[must_use]
#[inline(always)]
#[unstable(feature = "strict_provenance", issue = "95228")]
pub fn addr(self) -> usize {
// FIXME(strict_provenance_magic): 我是魔法,应该是编译器内部函数。
// SAFETY: 指针到整数的转换是有效的 (如果您同意丢失出处的话)。
//
unsafe { mem::transmute(self.cast::<()>()) }
}
/// 获取指针的 "address" 部分,并暴露 "provenance" 部分,以便将来在 [`from_exposed_addr`][] 中使用。
///
/// 这相当于 `self as usize`,它在语义上丢弃了 *provenance* 和 *address-space* 信息。
/// 此外,这 (如 `as` cast 一样) 具有将出处标记为 'exposed' 的隐式副作用,因此在支持它的平台上,您可以稍后调用 [`from_exposed_addr`][] 来重构原始指针,包括其出处。
///
/// (如果需要,重建地址空间信息是您的责任。)
///
/// 使用这种方法意味着代码没有遵循严格的出处规则。
/// 支持 [`from_exposed_addr`][] 会使规范和推理复杂化,并且可能不受帮助您与 Rust 内存模型保持一致的工具的支持,因此建议尽可能使用 [`addr`][pointer::addr]。
///
/// 在大多数平台上,这将产生一个与原始指针具有相同字节的值,因为所有字节都专用于描述地址。
/// 需要在指针中存储附加信息的平台可能不支持此操作,因为 [`from_exposed_addr`][] 工作所需的 'expose' 副作用通常不可用。
///
/// 此 API 及其声明的语义是 Strict Provenance 实验的一部分,有关详细信息,请参见 [模块文档][crate::ptr]。
///
/// [`from_exposed_addr`]: from_exposed_addr
///
///
///
///
///
///
///
///
#[must_use]
#[inline(always)]
#[unstable(feature = "strict_provenance", issue = "95228")]
pub fn expose_addr(self) -> usize {
// FIXME(strict_provenance_magic): 我是魔法,应该是编译器内部函数。
self.cast::<()>() as usize
}
/// 使用给定地址创建一个新指针。
///
/// 这执行与 `addr as ptr` 强制转换相同的操作,但将 `self` 的 *address-space* 和 *provenance* 复制到新指针。
/// 这使我们能够动态地保存和传播这些重要信息,而这在其他情况下使用一元强制转换是不可能的。
///
/// 这相当于使用 [`wrapping_offset`][pointer::wrapping_offset] 将 `self` 偏移到给定地址,因此具有所有相同的功能和限制。
///
///
/// 此 API 及其声明的语义是 Strict Provenance 实验的一部分,有关详细信息,请参见 [模块文档][crate::ptr]。
///
///
///
#[must_use]
#[inline]
#[unstable(feature = "strict_provenance", issue = "95228")]
pub fn with_addr(self, addr: usize) -> Self {
// FIXME(strict_provenance_magic): 我是魔法,应该是编译器内部函数。
//
// 同时,这个操作被定义为 "as if",它是一个 wrapping_offset,所以我们可以模拟它。
// 即使在今天的编译器下,这也应该正确地恢复指针 Provenance。
//
let self_addr = self.addr() as isize;
let dest_addr = addr as isize;
let offset = dest_addr.wrapping_sub(self_addr);
// 这是此操作的规范脱糖
self.wrapping_byte_offset(offset)
}
/// 通过将 `self` 的地址映射到新地址来创建新指针。
///
/// 这对 [`with_addr`][pointer::with_addr] 来说是一种方便,有关详细信息,请参见该方法。
///
/// 此 API 及其声明的语义是 Strict Provenance 实验的一部分,有关详细信息,请参见 [模块文档][crate::ptr]。
///
#[must_use]
#[inline]
#[unstable(feature = "strict_provenance", issue = "95228")]
pub fn map_addr(self, f: impl FnOnce(usize) -> usize) -> Self {
self.with_addr(f(self.addr()))
}
/// 将指针 (可能是宽指针) 分解为其地址和元数据组件。
///
/// 以后可以使用 [`from_raw_parts`] 重建指针。
#[unstable(feature = "ptr_metadata", issue = "81513")]
#[rustc_const_unstable(feature = "ptr_metadata", issue = "81513")]
#[inline]
pub const fn to_raw_parts(self) -> (*const (), <T as super::Pointee>::Metadata) {
(self.cast(), metadata(self))
}
/// 如果指针为空,则返回 `None`,否则返回 `Some` 中包装的值的共享引用。如果该值可能未初始化,则必须改用 [`as_uninit_ref`]。
///
/// [`as_uninit_ref`]: #method.as_uninit_ref
///
/// # Safety
///
/// 调用此方法时,您必须确保要么指针是空的,要么以下所有内容都为 true:
///
/// * 指针必须正确对齐。
///
/// * 在 [模块的文档][the module documentation] 中定义的含义上,它必须是 "dereferenceable"。
///
/// * 指针必须指向 `T` 的初始化实例。
///
/// * 您必须执行 Rust 的别名规则,因为返回的生命周期 `'a` 是任意选择的,不一定反映数据的实际生命周期。
/// 特别是,当这个引用存在时,指针指向的内存不能发生可变 (`UnsafeCell` 内部除外)。
///
/// 即使未使用此方法的结果也是如此!
/// (关于初始化的部分尚未完全决定,但是直到确定之前,唯一安全的方法是确保它们确实被初始化。)
///
/// [the module documentation]: crate::ptr#safety
///
/// # Examples
///
/// ```
/// let ptr: *const u8 = &10u8 as *const u8;
///
/// unsafe {
/// if let Some(val_back) = ptr.as_ref() {
/// println!("We got back the value: {val_back}!");
/// }
/// }
/// ```
///
/// # 空未经检查的版本
///
/// 如果确定指针永远不会为空,并且正在寻找某种返回 `&T` 而不是 `Option<&T>` 的 `as_ref_unchecked`,请知道您可以直接引用该指针。
///
///
/// ```
/// let ptr: *const u8 = &10u8 as *const u8;
///
/// unsafe {
/// let val_back = &*ptr;
/// println!("We got back the value: {val_back}!");
/// }
/// ```
///
///
///
///
///
///
///
#[stable(feature = "ptr_as_ref", since = "1.9.0")]
#[rustc_const_unstable(feature = "const_ptr_as_ref", issue = "91822")]
#[inline]
pub const unsafe fn as_ref<'a>(self) -> Option<&'a T> {
// SAFETY: 调用者必须保证 `self` 对于引用有效 (如果它不为 null)。
//
if self.is_null() { None } else { unsafe { Some(&*self) } }
}
/// 如果指针为空,则返回 `None`,否则返回 `Some` 中包装的值的共享引用。
/// 与 [`as_ref`] 相比,这不需要将该值初始化。
///
/// [`as_ref`]: #method.as_ref
///
/// # Safety
///
/// 调用此方法时,您必须确保要么指针是空的,要么以下所有内容都为 true:
///
/// * 指针必须正确对齐。
///
/// * 在 [模块的文档][the module documentation] 中定义的含义上,它必须是 "dereferenceable"。
///
/// * 您必须执行 Rust 的别名规则,因为返回的生命周期 `'a` 是任意选择的,不一定反映数据的实际生命周期。
///
/// 特别是,当这个引用存在时,指针指向的内存不能发生可变 (`UnsafeCell` 内部除外)。
///
/// 即使未使用此方法的结果也是如此!
///
/// [the module documentation]: crate::ptr#safety
///
/// # Examples
///
/// ```
/// #![feature(ptr_as_uninit)]
///
/// let ptr: *const u8 = &10u8 as *const u8;
///
/// unsafe {
/// if let Some(val_back) = ptr.as_uninit_ref() {
/// println!("We got back the value: {}!", val_back.assume_init());
/// }
/// }
/// ```
///
///
///
#[inline]
#[unstable(feature = "ptr_as_uninit", issue = "75402")]
#[rustc_const_unstable(feature = "const_ptr_as_ref", issue = "91822")]
pub const unsafe fn as_uninit_ref<'a>(self) -> Option<&'a MaybeUninit<T>>
where
T: Sized,
{
// SAFETY: 调用者必须保证 `self` 满足引用的所有要求。
//
if self.is_null() { None } else { Some(unsafe { &*(self as *const MaybeUninit<T>) }) }
}
/// 计算与指针的偏移量。
///
/// `count` 以 T 为单位; 例如,`count` 为 3 表示 `3 * size_of::<T>()` 字节的指针偏移量。
///
/// # Safety
///
/// 如果违反以下任一条件,则结果为未定义行为:
///
/// * 起始指针和结果指针都必须在边界内或在同一个 [分配对象][allocated object] 的末尾之后一个字节。
///
/// * 计算的偏移量 (以字节为单位) 不会使 `isize` 溢出。
///
/// * 偏移量不能依赖 "wrapping around" 地址空间。也就是说,无限精度总和 (以字节为单位) 必须适合于 usize。
///
/// 编译器和标准库通常会尝试确保分配永远不会达到需要考虑偏移量的大小。
/// 例如,`Vec` 和 `Box` 确保它们分配的字节数永远不会超过 `isize::MAX` 字节,因此 `vec.as_ptr().add(vec.len())` 始终是安全的。
///
/// 从根本上说,大多数平台甚至都无法构造这样的分配。
/// 例如,由于页表的限制或地址空间的分割,没有已知的 64 位平台可以满足 2 <sup>63</sup> 字节的请求。
/// 但是,某些 32 位和 16 位平台可能通过物理地址扩展之类的东西成功地为超过 `isize::MAX` 字节的请求提供服务。
///
/// 因此,直接从分配器获取的内存或内存映射文件 *可能* 太大而无法使用此函数进行处理。
///
/// 如果这些约束难以满足,请考虑使用 [`wrapping_offset`]。
/// 此方法的唯一优点是,它可以实现更积极的编译器优化。
///
/// [`wrapping_offset`]: #method.wrapping_offset
/// [allocated object]: crate::ptr#allocated-object
///
/// # Examples
///
/// ```
/// let s: &str = "123";
/// let ptr: *const u8 = s.as_ptr();
///
/// unsafe {
/// println!("{}", *ptr.offset(1) as char);
/// println!("{}", *ptr.offset(2) as char);
/// }
/// ```
///
///
///
///
///
///
///
///
///
#[stable(feature = "rust1", since = "1.0.0")]
#[must_use = "returns a new pointer rather than modifying its argument"]
#[rustc_const_stable(feature = "const_ptr_offset", since = "1.61.0")]
#[inline(always)]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub const unsafe fn offset(self, count: isize) -> *const T
where
T: Sized,
{
// SAFETY: 调用者必须遵守 `offset` 的安全保证。
unsafe { intrinsics::offset(self, count) }
}
/// 计算与指针的偏移量 (以字节为单位)。
///
/// `count` 以 **字节** 为单位。
///
/// 这纯粹是为了方便转换为 `u8` 指针并在其上使用 [offset][pointer::offset]。
/// 有关文档和安全要求,请参见该方法。
///
/// 对于非 `Sized` 指针,此操作仅更改数据指针,而保留元数据不变。
///
///
#[must_use]
#[inline(always)]
#[unstable(feature = "pointer_byte_offsets", issue = "96283")]
#[rustc_const_unstable(feature = "const_pointer_byte_offsets", issue = "96283")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub const unsafe fn byte_offset(self, count: isize) -> Self {
// SAFETY: 调用者必须遵守 `offset` 的安全保证。
unsafe { self.cast::<u8>().offset(count).with_metadata_of(self) }
}
/// 使用换行算法计算与指针的偏移量。
///
/// `count` 以 T 为单位; 例如,`count` 为 3 表示 `3 * size_of::<T>()` 字节的指针偏移量。
///
/// # Safety
///
/// 此操作本身始终是安全的,但使用结果指针则不安全。
///
/// 结果指针 "remembers" 是 `self` 指向的 [分配对象][allocated object]; 它不得用于读取或写入其他分配的对象。
///
/// 换句话说,即使我们假设 `T` 的大小为 `1` 并且没有溢出,`let z = x.wrapping_offset((y as isize) - (x as isize))` 不会使 `z` 与 `y` 相同: `z` 仍附加到对象 `x` 所附加的对象,并且解引用它是 Undefined Behavior,除非 `x` 和 `y` 指向同一分配的对象。
///
/// 与 [`offset`] 相比,此方法从根本上延迟了留在同一分配对象内的需求: [`offset`] 是跨越对象边界时的立即未定义行为; `wrapping_offset` 产生一个指针,但如果指针超出其附加对象的范围而被解引用,则仍会导致未定义行为。
/// [`offset`] 可以更好地优化,因此在性能敏感的代码中更可取。
///
/// 延迟检查仅考虑解引用的指针的值,而不考虑最终结果计算期间使用的中间值。
/// 例如,`x.wrapping_offset(o).wrapping_offset(o.wrapping_neg())` 始终与 `x` 相同。换句话说,允许离开已分配的对象,然后在以后重新输入它。
///
/// [`offset`]: #method.offset
/// [allocated object]: crate::ptr#allocated-object
///
/// # Examples
///
/// ```
/// // 使用裸指针以两个元素为增量进行迭代
/// let data = [1u8, 2, 3, 4, 5];
/// let mut ptr: *const u8 = data.as_ptr();
/// let step = 2;
/// let end_rounded_up = ptr.wrapping_offset(6);
///
/// // 此循环打印 "1, 3, 5, "
/// while ptr != end_rounded_up {
/// unsafe {
/// print!("{}, ", *ptr);
/// }
/// ptr = ptr.wrapping_offset(step);
/// }
/// ```
///
///
///
///
///
///
///
///
///
///
#[stable(feature = "ptr_wrapping_offset", since = "1.16.0")]
#[must_use = "returns a new pointer rather than modifying its argument"]
#[rustc_const_stable(feature = "const_ptr_offset", since = "1.61.0")]
#[inline(always)]
pub const fn wrapping_offset(self, count: isize) -> *const T
where
T: Sized,
{
// SAFETY: `arith_offset` 内部函数没有要调用的先决条件。
unsafe { intrinsics::arith_offset(self, count) }
}
/// 使用环绕算法计算与指针的偏移量 (以字节为单位)。
///
/// `count` 以 **字节** 为单位。
///
/// 这纯粹是为了方便转换为 `u8` 指针并在其上使用 [wrapping_offset][pointer::wrapping_offset]。
/// 请参见该方法以获取文档。
///
/// 对于非 `Sized` 指针,此操作仅更改数据指针,而保留元数据不变。
///
///
#[must_use]
#[inline(always)]
#[unstable(feature = "pointer_byte_offsets", issue = "96283")]
#[rustc_const_unstable(feature = "const_pointer_byte_offsets", issue = "96283")]
pub const fn wrapping_byte_offset(self, count: isize) -> Self {
self.cast::<u8>().wrapping_offset(count).with_metadata_of(self)
}
/// 根据掩码屏蔽指针的位。
///
/// 这对 `ptr.map_addr(|a| a & mask)` 来说很方便。
///
/// 对于非 `Sized` 指针,此操作仅更改数据指针,而保留元数据不变。
///
///
/// ## Examples
///
/// ```
/// #![feature(ptr_mask, strict_provenance)]
/// let v = 17_u32;
/// let ptr: *const u32 = &v;
///
/// // `u32` 是 4 字节对齐的,这意味着低 2 位总是 0.
/////
/// let tag_mask = 0b11;
/// let ptr_mask = !tag_mask;
///
/// // 我们可以在这些低位存储一些东西
/// let tagged_ptr = ptr.map_addr(|a| a | 0b10);
///
/// // 取回 "tag"
/// let tag = tagged_ptr.addr() & tag_mask;
/// assert_eq!(tag, 0b10);
///
/// // 注意 `tagged_ptr` 是未对齐的,它是 UB 读取它。
/// // 要获得原始指针 `mask` 可以使用:
/// let masked_ptr = tagged_ptr.mask(ptr_mask);
/// assert_eq!(unsafe { *masked_ptr }, 17);
/// ```
#[unstable(feature = "ptr_mask", issue = "98290")]
#[must_use = "returns a new pointer rather than modifying its argument"]
#[inline(always)]
pub fn mask(self, mask: usize) -> *const T {
intrinsics::ptr_mask(self.cast::<()>(), mask).with_metadata_of(self)
}
/// 计算两个指针之间的距离。返回值以 T 为单位: 以字节为单位的距离除以 `mem::size_of::<T>()`。
///
/// 该函数是 [`offset`] 的逆函数。
///
/// [`offset`]: #method.offset
///
/// # Safety
///
/// 如果违反以下任一条件,则结果为未定义行为:
///
/// * 起始指针和其他指针都必须在边界内或在同一个 [分配对象][allocated object] 的末尾之后一个字节。
///
/// * 两个指针必须是指向同一对象的指针的 *derived。
/// (请参见下面的示例。)
///
/// * 指针之间的距离 (以字节为单位) 必须是 `T` 大小的精确倍数。
///
/// * 指针之间的距离 (以字节为单位) 不会溢出 `isize`。
///
/// * 该距离不能依赖于 "wrapping around" 地址空间。
///
/// Rust 类型从不大于 `isize::MAX`,并且 Rust 分配从不环绕地址空间,因此,任何 Rust 类型 `T` 的某个值内的两个指针将始终满足最后两个条件。
///
/// 标准库通常还确保分配永远不会达到需要考虑偏移量的大小。
/// 例如,`Vec` 和 `Box` 确保它们分配的字节数永远不超过 `isize::MAX` 字节,因此 `ptr_into_vec.offset_from(vec.as_ptr())` 始终满足最后两个条件。
///
/// 从根本上说,大多数平台甚至都无法构建如此大的分配。
/// 例如,由于页表的限制或地址空间的分割,没有已知的 64 位平台可以满足 2 <sup>63</sup> 字节的请求。
/// 但是,某些 32 位和 16 位平台可能通过物理地址扩展之类的东西成功地为超过 `isize::MAX` 字节的请求提供服务。
/// 因此,直接从分配器获取的内存或内存映射文件 *可能* 太大而无法使用此函数进行处理。
/// (请注意,[`offset`] 和 [`add`] 也具有类似的限制,因此也不能在如此大的分配上使用。)
///
/// [`add`]: #method.add
/// [allocated object]: crate::ptr#allocated-object
///
/// # Panics
///
/// 如果 `T` 是零大小类型 ("ZST"),则此函数 panics。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [0; 5];
/// let ptr1: *const i32 = &a[1];
/// let ptr2: *const i32 = &a[3];
/// unsafe {
/// assert_eq!(ptr2.offset_from(ptr1), 2);
/// assert_eq!(ptr1.offset_from(ptr2), -2);
/// assert_eq!(ptr1.offset(2), ptr2);
/// assert_eq!(ptr2.offset(-2), ptr1);
/// }
/// ```
///
/// *不正确* 用法:
///
/// ```rust,no_run
/// let ptr1 = Box::into_raw(Box::new(0u8)) as *const u8;
/// let ptr2 = Box::into_raw(Box::new(1u8)) as *const u8;
/// let diff = (ptr2 as isize).wrapping_sub(ptr1 as isize);
/// // 将 ptr2_other 设置为 ptr2 的 "alias",但从 ptr1 派生。
/// let ptr2_other = (ptr1 as *const u8).wrapping_offset(diff);
/// assert_eq!(ptr2 as usize, ptr2_other as usize);
/// // 由于 ptr2_other 和 ptr2 是从指向不同对象的指针派生的,因此即使它们指向相同的地址,计算其偏移量也是未定义的行为!
/////
/////
/// unsafe {
/// let zero = ptr2_other.offset_from(ptr2); // 未定义的行为
/// }
/// ```
///
///
///
///
///
///
///
///
///
///
#[stable(feature = "ptr_offset_from", since = "1.47.0")]
#[rustc_const_stable(feature = "const_ptr_offset_from", since = "1.65.0")]
#[inline]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub const unsafe fn offset_from(self, origin: *const T) -> isize
where
T: Sized,
{
let pointee_size = mem::size_of::<T>();
assert!(0 < pointee_size && pointee_size <= isize::MAX as usize);
// SAFETY: 调用者必须遵守 `ptr_offset_from` 的安全保证。
unsafe { intrinsics::ptr_offset_from(self, origin) }
}
/// 计算两个指针之间的距离。返回值以 **字节** 为单位。
///
/// 这纯粹是为了方便转换为 `u8` 指针并在其上使用 [offset_from][pointer::offset_from]。
/// 有关文档和安全要求,请参见该方法。
///
/// 对于非 `Sized` 指针,此操作仅考虑数据指针,忽略元数据。
///
///
///
#[inline(always)]
#[unstable(feature = "pointer_byte_offsets", issue = "96283")]
#[rustc_const_unstable(feature = "const_pointer_byte_offsets", issue = "96283")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub const unsafe fn byte_offset_from<U: ?Sized>(self, origin: *const U) -> isize {
// SAFETY: 调用者必须遵守 `offset_from` 的安全保证。
unsafe { self.cast::<u8>().offset_from(origin.cast::<u8>()) }
}
/// 计算两个指针之间的距离,*where 已知 `self` 等于或大于 `origin`*。返回值以 T 为单位: 以字节为单位的距离除以 `mem::size_of::<T>()`。
///
/// 这将计算 [`offset_from`](#method.offset_from) 将计算的相同值,但附加的前提条件是偏移量保证为非 negative。
/// 此方法等同于 `usize::try_from(self.offset_from(origin)).unwrap_unchecked()`,但它为优化器提供了更多的信息,这有时可以使其在某些后端优化得更好。
///
///
/// 这个方法可以看作是恢复传递给 [`add`](#method.add) 的 `count` (或者,使用其他顺序的参数,到 [`sub`](#method.sub)).
/// 以下都是等价的,假设它们的安全先决条件得到满足:
///
/// ```rust
/// # #![feature(ptr_sub_ptr)]
/// # unsafe fn blah(ptr: *const i32, origin: *const i32, count: usize) -> bool {
/// ptr.sub_ptr(origin) == count
/// # &&
/// origin.add(count) == ptr
/// # &&
/// ptr.sub(count) == origin
/// # }
/// ```
///
/// # Safety
///
/// - 指针之间的距离必须是非 negative (`self >= origin`)
///
/// - *所有*[`offset_from`](#method.offset_from) 的安全条件也适用于此方法; 查看完整的详细信息。
///
/// 重要的是,尽管此方法的返回类型能够表示更大的偏移量,但仍然*不允许*传递相差超过 `isize::MAX` *bytes* 的指针。
/// 因此,此方法的结果将始终小于或等于 `isize::MAX as usize`。
///
/// # Panics
///
/// 如果 `T` 是零大小类型 ("ZST"),则此函数 panics。
///
/// # Examples
///
/// ```
/// #![feature(ptr_sub_ptr)]
///
/// let a = [0; 5];
/// let ptr1: *const i32 = &a[1];
/// let ptr2: *const i32 = &a[3];
/// unsafe {
/// assert_eq!(ptr2.sub_ptr(ptr1), 2);
/// assert_eq!(ptr1.add(2), ptr2);
/// assert_eq!(ptr2.sub(2), ptr1);
/// assert_eq!(ptr2.sub_ptr(ptr2), 0);
/// }
///
/// // 这是不正确的,因为指针的顺序不正确:
/// // ptr1.sub_ptr(ptr2)
/// ```
///
///
///
///
///
///
///
///
///
#[unstable(feature = "ptr_sub_ptr", issue = "95892")]
#[rustc_const_unstable(feature = "const_ptr_sub_ptr", issue = "95892")]
#[inline]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub const unsafe fn sub_ptr(self, origin: *const T) -> usize
where
T: Sized,
{
let this = self;
// SAFETY: 比较没有副作用,内部函数在 CTFE 实现中进行内部检查。
//
unsafe {
assert_unsafe_precondition!(
"ptr::sub_ptr requires `this >= origin`",
[T](this: *const T, origin: *const T) => this >= origin
)
};
let pointee_size = mem::size_of::<T>();
assert!(0 < pointee_size && pointee_size <= isize::MAX as usize);
// SAFETY: 调用者必须维护 `ptr_offset_from_unsigned` 的安全保证。
unsafe { intrinsics::ptr_offset_from_unsigned(self, origin) }
}
/// 返回两个指针是否保证相等。
///
/// 在运行时,这个函数的行为类似于 `Some(self == other)`。
/// 但是,在某些情况下 (例如,编译时评估),并不总是可以确定两个指针的相等性,因此该函数可能会虚假地返回 `None` 以获取稍后实际上证明其相等性已知的指针。
///
/// 但是当它返回 `Some` 时,可以保证知道指针的相等性。
///
/// 返回值可能会从 `Some` 更改为 `None`,反之亦然,具体取决于编译器版本,并且不安全的代码不能依赖此函数的结果来保证可靠性。
/// 建议仅将此函数用于性能优化,其中此函数的虚假 `None` 返回值不会影响结果,而只会影响性能。
/// 尚未探讨使用此方法使运行时和编译时代码表现不同的后果。
/// 不应使用这种方法来引入这种差异,并且在我们对这个问题有更好的理解之前,也不应使其稳定。
///
///
///
///
///
///
#[unstable(feature = "const_raw_ptr_comparison", issue = "53020")]
#[rustc_const_unstable(feature = "const_raw_ptr_comparison", issue = "53020")]
#[inline]
pub const fn guaranteed_eq(self, other: *const T) -> Option<bool>
where
T: Sized,
{
match intrinsics::ptr_guaranteed_cmp(self as _, other as _) {
2 => None,
other => Some(other == 1),
}
}
/// 返回是否保证两个指针不相等。
///
/// 在运行时,这个函数的行为类似于 `Some(self != other)`。
/// 然而,在某些情况下 (例如,编译时求值),并不总是可以确定两个指针的不等式,因此该函数可能会虚假地返回 `None` 以获取后来实际证明其不等式的指针。
///
/// 但是当它返回 `Some` 时,指针的不等式保证是已知的。
///
/// 返回值可能会从 `Some` 更改为 `None`,反之亦然,具体取决于编译器版本,并且不安全的代码不能依赖此函数的结果来保证可靠性。
/// 建议仅将此函数用于性能优化,其中此函数的虚假 `None` 返回值不会影响结果,而只会影响性能。
/// 尚未探讨使用此方法使运行时和编译时代码表现不同的后果。
/// 不应使用这种方法来引入这种差异,并且在我们对这个问题有更好的理解之前,也不应使其稳定。
///
///
///
///
///
///
#[unstable(feature = "const_raw_ptr_comparison", issue = "53020")]
#[rustc_const_unstable(feature = "const_raw_ptr_comparison", issue = "53020")]
#[inline]
pub const fn guaranteed_ne(self, other: *const T) -> Option<bool>
where
T: Sized,
{
match self.guaranteed_eq(other) {
None => None,
Some(eq) => Some(!eq),
}
}
/// 计算与指针的偏移量 (`.offset(count as isize)` 的便利性)。
///
/// `count` 以 T 为单位; 例如,`count` 为 3 表示 `3 * size_of::<T>()` 字节的指针偏移量。
///
/// # Safety
///
/// 如果违反以下任一条件,则结果为未定义行为:
///
/// * 起始指针和结果指针都必须在边界内或在同一个 [分配对象][allocated object] 的末尾之后一个字节。
///
/// * 计算的偏移量 (以字节为单位) 不会使 `isize` 溢出。
///
/// * 偏移量不能依赖 "wrapping around" 地址空间。也就是说,无限精度的总和必须符合 `usize`。
///
/// 编译器和标准库通常会尝试确保分配永远不会达到需要考虑偏移量的大小。
/// 例如,`Vec` 和 `Box` 确保它们分配的字节数永远不会超过 `isize::MAX` 字节,因此 `vec.as_ptr().add(vec.len())` 始终是安全的。
///
/// 从根本上说,大多数平台甚至都无法构造这样的分配。
/// 例如,由于页表的限制或地址空间的分割,没有已知的 64 位平台可以满足 2 <sup>63</sup> 字节的请求。
/// 但是,某些 32 位和 16 位平台可能通过物理地址扩展之类的东西成功地为超过 `isize::MAX` 字节的请求提供服务。
///
/// 因此,直接从分配器获取的内存或内存映射文件 *可能* 太大而无法使用此函数进行处理。
///
/// 如果这些约束难以满足,请考虑使用 [`wrapping_add`]。
/// 此方法的唯一优点是,它可以实现更积极的编译器优化。
///
/// [`wrapping_add`]: #method.wrapping_add
/// [allocated object]: crate::ptr#allocated-object
///
/// # Examples
///
/// ```
/// let s: &str = "123";
/// let ptr: *const u8 = s.as_ptr();
///
/// unsafe {
/// println!("{}", *ptr.add(1) as char);
/// println!("{}", *ptr.add(2) as char);
/// }
/// ```
///
///
///
///
///
///
///
///
///
#[stable(feature = "pointer_methods", since = "1.26.0")]
#[must_use = "returns a new pointer rather than modifying its argument"]
#[rustc_const_stable(feature = "const_ptr_offset", since = "1.61.0")]
#[inline(always)]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub const unsafe fn add(self, count: usize) -> Self
where
T: Sized,
{
#[cfg(bootstrap)]
// SAFETY: 调用者必须遵守 `offset` 的安全保证。
unsafe {
self.offset(count as isize)
}
#[cfg(not(bootstrap))]
// SAFETY: 调用者必须遵守 `offset` 的安全保证。
unsafe {
intrinsics::offset(self, count)
}
}
/// 以字节为单位计算指针的偏移量 (方便 `.byte_offset(count as isize)`)。
///
/// `count` 以字节为单位。
///
/// 这纯粹是为了方便转换为 `u8` 指针并在其上使用 [add][pointer::add]。
/// 有关文档和安全要求,请参见该方法。
///
/// 对于非 `Sized` 指针,此操作仅更改数据指针,而保留元数据不变。
///
///
#[must_use]
#[inline(always)]
#[unstable(feature = "pointer_byte_offsets", issue = "96283")]
#[rustc_const_unstable(feature = "const_pointer_byte_offsets", issue = "96283")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub const unsafe fn byte_add(self, count: usize) -> Self {
// SAFETY: 调用者必须维护 `add` 的安全保证。
unsafe { self.cast::<u8>().add(count).with_metadata_of(self) }
}
/// 计算与指针的偏移量 (`.offset((count as isize).wrapping_neg())` 的便利性)。
///
/// `count` 以 T 为单位; 例如,`count` 为 3 表示 `3 * size_of::<T>()` 字节的指针偏移量。
///
/// # Safety
///
/// 如果违反以下任一条件,则结果为未定义行为:
///
/// * 起始指针和结果指针都必须在边界内或在同一个 [分配对象][allocated object] 的末尾之后一个字节。
///
/// * 计算的偏移量不能超过 `isize::MAX` 个 **字节**。
///
/// * 偏移量不能依赖 "wrapping around" 地址空间。也就是说,无限精度的总和必须符合使用大小。
///
/// 编译器和标准库通常会尝试确保分配永远不会达到需要考虑偏移量的大小。
/// 例如,`Vec` 和 `Box` 确保它们分配的字节数永远不会超过 `isize::MAX` 字节,因此 `vec.as_ptr().add(vec.len()).sub(vec.len())` 始终是安全的。
///
/// 从根本上说,大多数平台甚至都无法构造这样的分配。
/// 例如,由于页表的限制或地址空间的分割,没有已知的 64 位平台可以满足 2 <sup>63</sup> 字节的请求。
/// 但是,某些 32 位和 16 位平台可能通过物理地址扩展之类的东西成功地为超过 `isize::MAX` 字节的请求提供服务。
///
/// 因此,直接从分配器获取的内存或内存映射文件 *可能* 太大而无法使用此函数进行处理。
///
/// 如果这些约束难以满足,请考虑使用 [`wrapping_sub`]。
/// 此方法的唯一优点是,它可以实现更积极的编译器优化。
///
/// [`wrapping_sub`]: #method.wrapping_sub
/// [allocated object]: crate::ptr#allocated-object
///
/// # Examples
///
/// ```
/// let s: &str = "123";
///
/// unsafe {
/// let end: *const u8 = s.as_ptr().add(3);
/// println!("{}", *end.sub(1) as char);
/// println!("{}", *end.sub(2) as char);
/// }
/// ```
///
///
///
///
///
///
///
///
///
///
#[stable(feature = "pointer_methods", since = "1.26.0")]
#[must_use = "returns a new pointer rather than modifying its argument"]
#[rustc_const_stable(feature = "const_ptr_offset", since = "1.61.0")]
#[inline(always)]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub const unsafe fn sub(self, count: usize) -> Self
where
T: Sized,
{
// SAFETY: 调用者必须遵守 `offset` 的安全保证。
unsafe { self.offset((count as isize).wrapping_neg()) }
}
/// 以字节为单位计算指针的偏移量 (方便 `.byte_offset((count as isize).wrapping_neg())`)。
///
///
/// `count` 以字节为单位。
///
/// 这纯粹是为了方便转换为 `u8` 指针并在其上使用 [sub][pointer::sub]。
/// 有关文档和安全要求,请参见该方法。
///
/// 对于非 `Sized` 指针,此操作仅更改数据指针,而保留元数据不变。
///
///
#[must_use]
#[inline(always)]
#[unstable(feature = "pointer_byte_offsets", issue = "96283")]
#[rustc_const_unstable(feature = "const_pointer_byte_offsets", issue = "96283")]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub const unsafe fn byte_sub(self, count: usize) -> Self {
// SAFETY: 调用者必须维护 `sub` 的安全保证。
unsafe { self.cast::<u8>().sub(count).with_metadata_of(self) }
}
/// 使用换行算法计算与指针的偏移量。
/// (为 `.wrapping_offset(count as isize)` 带来的便利)
///
/// `count` 以 T 为单位; 例如,`count` 为 3 表示 `3 * size_of::<T>()` 字节的指针偏移量。
///
/// # Safety
///
/// 此操作本身始终是安全的,但使用结果指针则不安全。
///
/// 结果指针 "remembers" 是 `self` 指向的 [分配对象][allocated object]; 它不得用于读取或写入其他分配的对象。
///
/// 换句话说,即使我们假设 `T` 的大小为 `1` 并且没有溢出,`let z = x.wrapping_add((y as usize) - (x as usize))` 不会使 `z` 与 `y` 相同: `z` 仍附加到对象 `x` 所附加的对象,并且解引用它是 Undefined Behavior,除非 `x` 和 `y` 指向同一分配的对象。
///
/// 与 [`add`] 相比,此方法从根本上延迟了留在同一分配对象内的需求: [`add`] 是跨越对象边界时的立即未定义行为; `wrapping_add` 产生一个指针,但如果指针超出其附加对象的范围而被解引用,则仍会导致未定义行为。
/// [`add`] 可以更好地优化,因此在性能敏感的代码中更可取。
///
/// 延迟检查仅考虑解引用的指针的值,而不考虑最终结果计算期间使用的中间值。
/// 例如,`x.wrapping_add(o).wrapping_sub(o)` 始终与 `x` 相同。换句话说,允许离开已分配的对象,然后在以后重新输入它。
///
/// [`add`]: #method.add
/// [allocated object]: crate::ptr#allocated-object
///
/// # Examples
///
/// ```
/// // 使用裸指针以两个元素为增量进行迭代
/// let data = [1u8, 2, 3, 4, 5];
/// let mut ptr: *const u8 = data.as_ptr();
/// let step = 2;
/// let end_rounded_up = ptr.wrapping_add(6);
///
/// // 此循环打印 "1, 3, 5, "
/// while ptr != end_rounded_up {
/// unsafe {
/// print!("{}, ", *ptr);
/// }
/// ptr = ptr.wrapping_add(step);
/// }
/// ```
///
///
///
///
///
///
///
///
///
///
#[stable(feature = "pointer_methods", since = "1.26.0")]
#[must_use = "returns a new pointer rather than modifying its argument"]
#[rustc_const_stable(feature = "const_ptr_offset", since = "1.61.0")]
#[inline(always)]
pub const fn wrapping_add(self, count: usize) -> Self
where
T: Sized,
{
self.wrapping_offset(count as isize)
}
/// 使用环绕算法计算与指针的偏移量 (以字节为单位)。
/// (便于 `.wrapping_byte_offset(计为 isize)`)
///
/// `count` 以字节为单位。
///
/// 这纯粹是为了方便转换为 `u8` 指针并在其上使用 [wrapping_add][pointer::wrapping_add]。
/// 请参见该方法以获取文档。
///
/// 对于非 `Sized` 指针,此操作仅更改数据指针,而保留元数据不变。
///
#[must_use]
#[inline(always)]
#[unstable(feature = "pointer_byte_offsets", issue = "96283")]
#[rustc_const_unstable(feature = "const_pointer_byte_offsets", issue = "96283")]
pub const fn wrapping_byte_add(self, count: usize) -> Self {
self.cast::<u8>().wrapping_add(count).with_metadata_of(self)
}
/// 使用换行算法计算与指针的偏移量。
/// (为 `.wrapping_offset((count as isize).wrapping_neg())` 带来的便利)
///
/// `count` 以 T 为单位; 例如,`count` 为 3 表示 `3 * size_of::<T>()` 字节的指针偏移量。
///
/// # Safety
///
/// 此操作本身始终是安全的,但使用结果指针则不安全。
///
/// 结果指针 "remembers" 是 `self` 指向的 [分配对象][allocated object]; 它不得用于读取或写入其他分配的对象。
///
/// 换句话说,即使我们假设 `T` 的大小为 `1` 并且没有溢出,`let z = x.wrapping_sub((x as usize) - (y as usize))` 不会使 `z` 与 `y` 相同: `z` 仍附加到对象 `x` 所附加的对象,并且解引用它是 Undefined Behavior,除非 `x` 和 `y` 指向同一分配的对象。
///
/// 与 [`sub`] 相比,此方法从根本上延迟了留在同一分配对象内的需求: [`sub`] 是跨越对象边界时的立即未定义行为; `wrapping_sub` 产生一个指针,但如果指针超出其附加对象的范围而被解引用,则仍会导致未定义行为。
/// [`sub`] 可以更好地优化,因此在性能敏感的代码中更可取。
///
/// 延迟检查仅考虑解引用的指针的值,而不考虑最终结果计算期间使用的中间值。
/// 例如,`x.wrapping_add(o).wrapping_sub(o)` 始终与 `x` 相同。换句话说,允许离开已分配的对象,然后在以后重新输入它。
///
/// [`sub`]: #method.sub
/// [allocated object]: crate::ptr#allocated-object
///
/// # Examples
///
/// ```
/// // 使用裸指针以两个元素 (backwards) 为增量进行迭代
/// let data = [1u8, 2, 3, 4, 5];
/// let mut ptr: *const u8 = data.as_ptr();
/// let start_rounded_down = ptr.wrapping_sub(2);
/// ptr = ptr.wrapping_add(4);
/// let step = 2;
/// // 此循环打印 "5, 3, 1, "
/// while ptr != start_rounded_down {
/// unsafe {
/// print!("{}, ", *ptr);
/// }
/// ptr = ptr.wrapping_sub(step);
/// }
/// ```
///
///
///
///
///
///
///
///
///
///
#[stable(feature = "pointer_methods", since = "1.26.0")]
#[must_use = "returns a new pointer rather than modifying its argument"]
#[rustc_const_stable(feature = "const_ptr_offset", since = "1.61.0")]
#[inline(always)]
pub const fn wrapping_sub(self, count: usize) -> Self
where
T: Sized,
{
self.wrapping_offset((count as isize).wrapping_neg())
}
/// 使用环绕算法计算与指针的偏移量 (以字节为单位)。
/// (为 `.wrapping_offset((count as isize).wrapping_neg())` 带来的便利)
///
/// `count` 以字节为单位。
///
/// 这纯粹是为了方便转换为 `u8` 指针并在其上使用 [wrapping_sub][pointer::wrapping_sub]。
/// 请参见该方法以获取文档。
///
/// 对于非 `Sized` 指针,此操作仅更改数据指针,而保留元数据不变。
///
#[must_use]
#[inline(always)]
#[unstable(feature = "pointer_byte_offsets", issue = "96283")]
#[rustc_const_unstable(feature = "const_pointer_byte_offsets", issue = "96283")]
pub const fn wrapping_byte_sub(self, count: usize) -> Self {
self.cast::<u8>().wrapping_sub(count).with_metadata_of(self)
}
/// 从 `self` 读取值而不移动它。
/// 这将使 `self` 中的内存保持不变。
///
/// 有关安全性问题和示例,请参见 [`ptr::read`]。
///
/// [`ptr::read`]: crate::ptr::read()
#[stable(feature = "pointer_methods", since = "1.26.0")]
#[rustc_const_stable(feature = "const_ptr_read", since = "1.71.0")]
#[inline]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub const unsafe fn read(self) -> T
where
T: Sized,
{
// SAFETY: 调用者必须遵守 `read` 的安全保证。
unsafe { read(self) }
}
/// 对 `self` 的值进行易失性读取,而无需移动它。这将使 `self` 中的内存保持不变。
///
/// 易失性操作旨在作用于 I/O 存储器,并保证编译器不会在其他易失性操作中对易失性操作进行清除或重新排序。
///
///
/// 有关安全性问题和示例,请参见 [`ptr::read_volatile`]。
///
/// [`ptr::read_volatile`]: crate::ptr::read_volatile()
///
///
#[stable(feature = "pointer_methods", since = "1.26.0")]
#[inline]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub unsafe fn read_volatile(self) -> T
where
T: Sized,
{
// SAFETY: 调用者必须遵守 `read_volatile` 的安全保证。
unsafe { read_volatile(self) }
}
/// 从 `self` 读取值而不移动它。
/// 这将使 `self` 中的内存保持不变。
///
/// 与 `read` 不同,指针可能未对齐。
///
/// 有关安全性问题和示例,请参见 [`ptr::read_unaligned`]。
///
/// [`ptr::read_unaligned`]: crate::ptr::read_unaligned()
#[stable(feature = "pointer_methods", since = "1.26.0")]
#[rustc_const_stable(feature = "const_ptr_read", since = "1.71.0")]
#[inline]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub const unsafe fn read_unaligned(self) -> T
where
T: Sized,
{
// SAFETY: 调用者必须遵守 `read_unaligned` 的安全保证。
unsafe { read_unaligned(self) }
}
/// 将 `count * size_of<T>` 字节从 `self` 复制到 `dest`。
/// 源和目标可能会重叠。
///
/// NOTE: 这与 [`ptr::copy`] 具有相同的参数顺序。
///
/// 有关安全性问题和示例,请参见 [`ptr::copy`]。
///
/// [`ptr::copy`]: crate::ptr::copy()
#[rustc_const_stable(feature = "const_intrinsic_copy", since = "1.63.0")]
#[stable(feature = "pointer_methods", since = "1.26.0")]
#[inline]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub const unsafe fn copy_to(self, dest: *mut T, count: usize)
where
T: Sized,
{
// SAFETY: 调用者必须遵守 `copy` 的安全保证。
unsafe { copy(self, dest, count) }
}
/// 将 `count * size_of<T>` 字节从 `self` 复制到 `dest`。
/// 源和目标可能 *不* 重叠。
///
/// NOTE: 这与 [`ptr::copy_nonoverlapping`] 具有相同的参数顺序。
///
/// 有关安全性问题和示例,请参见 [`ptr::copy_nonoverlapping`]。
///
/// [`ptr::copy_nonoverlapping`]: crate::ptr::copy_nonoverlapping()
#[rustc_const_stable(feature = "const_intrinsic_copy", since = "1.63.0")]
#[stable(feature = "pointer_methods", since = "1.26.0")]
#[inline]
#[cfg_attr(miri, track_caller)] // 即使没有 panic,这也有助于 Miri 回溯
pub const unsafe fn copy_to_nonoverlapping(self, dest: *mut T, count: usize)
where
T: Sized,
{
// SAFETY: 调用者必须遵守 `copy_nonoverlapping` 的安全保证。
unsafe { copy_nonoverlapping(self, dest, count) }
}
/// 计算为使其与 `align` 对齐而需要应用到指针的偏移量。
///
/// 如果无法对齐指针,则实现将返回 `usize::MAX`。
/// 允许实现 *始终* 返回 `usize::MAX`。
/// 只有算法的性能可以取决于此处是否可获得可用的偏移量,而不取决于其正确性。
///
/// 偏移量以 `T` 元素的数量表示,而不是以字节表示。返回的值可以与 `wrapping_add` 方法一起使用。
///
/// 不能保证偏移指针不会溢出或超出指针所指向的分配范围。
///
/// 调用者应确保返回的偏移量在对齐方式以外的所有方面都是正确的。
///
/// # Panics
///
/// 如果 `align` 不是 2 的幂,则函数 panics。
///
/// # Examples
///
/// 将相邻的 `u8` 作为 `u16` 进行访问
///
/// ```
/// use std::mem::align_of;
///
/// # unsafe {
/// let x = [5_u8, 6, 7, 8, 9];
/// let ptr = x.as_ptr();
/// let offset = ptr.align_offset(align_of::<u16>());
///
/// if offset < x.len() - 1 {
/// let u16_ptr = ptr.add(offset).cast::<u16>();
/// assert!(*u16_ptr == u16::from_ne_bytes([5, 6]) || *u16_ptr == u16::from_ne_bytes([6, 7]));
/// } else {
/// // 虽然指针可以通过 `offset` 对齐,但它会指向分配之外
/////
/// }
/// # }
/// ```
///
///
///
#[must_use]
#[inline]
#[stable(feature = "align_offset", since = "1.36.0")]
#[rustc_const_unstable(feature = "const_align_offset", issue = "90962")]
pub const fn align_offset(self, align: usize) -> usize
where
T: Sized,
{
if !align.is_power_of_two() {
panic!("align_offset: align is not a power-of-two");
}
{
// SAFETY: `align` 已被检查为 2 以上的幂
unsafe { align_offset(self, align) }
}
}
/// 返回指针是否为 `T` 正确对齐。
///
/// # Examples
///
/// ```
/// #![feature(pointer_is_aligned)]
/// #![feature(pointer_byte_offsets)]
///
/// // 在某些平台上,i32 的对齐小于 4.
/// #[repr(align(4))]
/// struct AlignedI32(i32);
///
/// let data = AlignedI32(42);
/// let ptr = &data as *const AlignedI32;
///
/// assert!(ptr.is_aligned());
/// assert!(!ptr.wrapping_byte_add(1).is_aligned());
/// ```
///
/// # 在编译时
/// **Note: 编译时的对齐是实验性的,可能会发生变化。有关详细信息,请参见 [tracking issue]。**
///
/// 在编译时,编译器可能不知道值将在内存中的何处结束。
/// 在编译时对从引用创建的指针调用此函数将仅在保证指针对齐的情况下返回 `true`。
/// 这意味着如果将指针转换为比引用的底层分配具有更严格对齐的类型,则指针永远不会对齐。
///
/// ```
/// #![feature(pointer_is_aligned)]
/// #![feature(const_pointer_is_aligned)]
///
/// // 在某些平台上,图元的对齐方式小于它们的大小。
/// #[repr(align(4))]
/// struct AlignedI32(i32);
/// #[repr(align(8))]
/// struct AlignedI64(i64);
///
/// const _: () = {
/// let data = AlignedI32(42);
/// let ptr = &data as *const AlignedI32;
/// assert!(ptr.is_aligned());
///
/// // 在运行时 `ptr1` 或 `ptr2` 将对齐,但在编译时两者都不对齐。
/// let ptr1 = ptr.cast::<AlignedI64>();
/// let ptr2 = ptr.wrapping_add(1).cast::<AlignedI64>();
/// assert!(!ptr1.is_aligned());
/// assert!(!ptr2.is_aligned());
/// };
/// ```
///
/// 由于此行为,即使编译时指针未对齐,派生自编译时指针的运行时指针也可能对齐。
///
///
/// ```
/// #![feature(pointer_is_aligned)]
/// #![feature(const_pointer_is_aligned)]
///
/// // 在某些平台上,图元的对齐方式小于它们的大小。
/// #[repr(align(4))]
/// struct AlignedI32(i32);
/// #[repr(align(8))]
/// struct AlignedI64(i64);
///
/// // 在编译时,`COMPTIME_PTR` 和 `COMPTIME_PTR + 1` 都没有对齐。
/// const COMPTIME_PTR: *const AlignedI32 = &AlignedI32(42);
/// const _: () = assert!(!COMPTIME_PTR.cast::<AlignedI64>().is_aligned());
/// const _: () = assert!(!COMPTIME_PTR.wrapping_add(1).cast::<AlignedI64>().is_aligned());
///
/// // 在运行时,`runtime_ptr` 或 `runtime_ptr + 1` 对齐。
/// let runtime_ptr = COMPTIME_PTR;
/// assert_ne!(
/// runtime_ptr.cast::<AlignedI64>().is_aligned(),
/// runtime_ptr.wrapping_add(1).cast::<AlignedI64>().is_aligned(),
/// );
/// ```
///
/// 如果指针是从固定地址创建的,则此函数在运行时和编译时的行为相同。
///
/// ```
/// #![feature(pointer_is_aligned)]
/// #![feature(const_pointer_is_aligned)]
///
/// // 在某些平台上,图元的对齐方式小于它们的大小。
/// #[repr(align(4))]
/// struct AlignedI32(i32);
/// #[repr(align(8))]
/// struct AlignedI64(i64);
///
/// const _: () = {
/// let ptr = 40 as *const AlignedI32;
/// assert!(ptr.is_aligned());
///
/// // 对于具有已知地址的指针,运行时和编译时行为是相同的。
/// let ptr1 = ptr.cast::<AlignedI64>();
/// let ptr2 = ptr.wrapping_add(1).cast::<AlignedI64>();
/// assert!(ptr1.is_aligned());
/// assert!(!ptr2.is_aligned());
/// };
/// ```
///
/// [tracking issue]: https://github.com/rust-lang/rust/issues/104203
///
///
///
///
#[must_use]
#[inline]
#[unstable(feature = "pointer_is_aligned", issue = "96284")]
#[rustc_const_unstable(feature = "const_pointer_is_aligned", issue = "104203")]
pub const fn is_aligned(self) -> bool
where
T: Sized,
{
self.is_aligned_to(mem::align_of::<T>())
}
/// 返回指针是否与 `align` 对齐。
///
/// 对于非 `Sized` 指针,此操作仅考虑数据指针,而忽略元数据。
///
/// # Panics
///
/// 如果 `align` 不是 2 的幂 (包括 0),函数会出现 panic。
///
/// # Examples
///
/// ```
/// #![feature(pointer_is_aligned)]
/// #![feature(pointer_byte_offsets)]
///
/// // 在某些平台上,i32 的对齐小于 4.
/// #[repr(align(4))]
/// struct AlignedI32(i32);
///
/// let data = AlignedI32(42);
/// let ptr = &data as *const AlignedI32;
///
/// assert!(ptr.is_aligned_to(1));
/// assert!(ptr.is_aligned_to(2));
/// assert!(ptr.is_aligned_to(4));
///
/// assert!(ptr.wrapping_byte_add(2).is_aligned_to(2));
/// assert!(!ptr.wrapping_byte_add(2).is_aligned_to(4));
///
/// assert_ne!(ptr.is_aligned_to(8), ptr.wrapping_add(1).is_aligned_to(8));
/// ```
///
/// # 在编译时
/// **Note: 编译时的对齐是实验性的,可能会发生变化。有关详细信息,请参见 [tracking issue]。**
///
/// 在编译时,编译器可能不知道值将在内存中的何处结束。
/// 在编译时对从引用创建的指针调用此函数将仅在保证指针对齐的情况下返回 `true`。
/// 这意味着指针不能比引用的底层分配更严格地对齐。
///
/// ```
/// #![feature(pointer_is_aligned)]
/// #![feature(const_pointer_is_aligned)]
///
/// // 在某些平台上,i32 的对齐小于 4.
/// #[repr(align(4))]
/// struct AlignedI32(i32);
///
/// const _: () = {
/// let data = AlignedI32(42);
/// let ptr = &data as *const AlignedI32;
///
/// assert!(ptr.is_aligned_to(1));
/// assert!(ptr.is_aligned_to(2));
/// assert!(ptr.is_aligned_to(4));
///
/// // 在编译时,我们确定指针没有对齐到 8.
/// assert!(!ptr.is_aligned_to(8));
/// assert!(!ptr.wrapping_add(1).is_aligned_to(8));
/// };
/// ```
///
/// 由于此行为,即使编译时指针未对齐,派生自编译时指针的运行时指针也可能对齐。
///
///
/// ```
/// #![feature(pointer_is_aligned)]
/// #![feature(const_pointer_is_aligned)]
///
/// // 在某些平台上,i32 的对齐小于 4.
/// #[repr(align(4))]
/// struct AlignedI32(i32);
///
/// // 在编译时,`COMPTIME_PTR` 和 `COMPTIME_PTR + 1` 都没有对齐。
/// const COMPTIME_PTR: *const AlignedI32 = &AlignedI32(42);
/// const _: () = assert!(!COMPTIME_PTR.is_aligned_to(8));
/// const _: () = assert!(!COMPTIME_PTR.wrapping_add(1).is_aligned_to(8));
///
/// // 在运行时,`runtime_ptr` 或 `runtime_ptr + 1` 对齐。
/// let runtime_ptr = COMPTIME_PTR;
/// assert_ne!(
/// runtime_ptr.is_aligned_to(8),
/// runtime_ptr.wrapping_add(1).is_aligned_to(8),
/// );
/// ```
///
/// 如果指针是从固定地址创建的,则此函数在运行时和编译时的行为相同。
///
/// ```
/// #![feature(pointer_is_aligned)]
/// #![feature(const_pointer_is_aligned)]
///
/// const _: () = {
/// let ptr = 40 as *const u8;
/// assert!(ptr.is_aligned_to(1));
/// assert!(ptr.is_aligned_to(2));
/// assert!(ptr.is_aligned_to(4));
/// assert!(ptr.is_aligned_to(8));
/// assert!(!ptr.is_aligned_to(16));
/// };
/// ```
///
/// [tracking issue]: https://github.com/rust-lang/rust/issues/104203
///
///
///
///
#[must_use]
#[inline]
#[unstable(feature = "pointer_is_aligned", issue = "96284")]
#[rustc_const_unstable(feature = "const_pointer_is_aligned", issue = "104203")]
pub const fn is_aligned_to(self, align: usize) -> bool {
if !align.is_power_of_two() {
panic!("is_aligned_to: align is not a power-of-two");
}
#[inline]
fn runtime_impl(ptr: *const (), align: usize) -> bool {
ptr.addr() & (align - 1) == 0
}
#[inline]
const fn const_impl(ptr: *const (), align: usize) -> bool {
// 我们不能在 `const fn` 中使用 `self` 的地址,所以我们使用 `align_offset` 代替。
// 转换为 `()` 用于
// 1. 处理胖指针; and
// 2. 确保 `align_offset` 实际上不会尝试计算偏移量。
ptr.align_offset(align) == 0
}
// SAFETY: 这两个版本在运行时是等效的。
unsafe { const_eval_select((self.cast::<()>(), align), const_impl, runtime_impl) }
}
}
impl<T> *const [T] {
/// 返回原始切片的长度。
///
/// 返回的值是 **元素** 的数量,而不是字节数。
///
/// 即使原始切片由于指针为空或未对齐而无法转换为切片引用,此函数也是安全的。
///
///
/// # Examples
///
/// ```rust
/// #![feature(slice_ptr_len)]
///
/// use std::ptr;
///
/// let slice: *const [i8] = ptr::slice_from_raw_parts(ptr::null(), 3);
/// assert_eq!(slice.len(), 3);
/// ```
#[inline]
#[unstable(feature = "slice_ptr_len", issue = "71146")]
#[rustc_const_unstable(feature = "const_slice_ptr_len", issue = "71146")]
pub const fn len(self) -> usize {
metadata(self)
}
/// 将裸指针返回到切片的缓冲区。
///
/// 这等效于将 `self` 强制转换为 `*const T`,但类型安全性更高。
///
/// # Examples
///
/// ```rust
/// #![feature(slice_ptr_get)]
/// use std::ptr;
///
/// let slice: *const [i8] = ptr::slice_from_raw_parts(ptr::null(), 3);
/// assert_eq!(slice.as_ptr(), ptr::null());
/// ```
#[inline]
#[unstable(feature = "slice_ptr_get", issue = "74265")]
#[rustc_const_unstable(feature = "slice_ptr_get", issue = "74265")]
pub const fn as_ptr(self) -> *const T {
self as *const T
}
/// 将裸指针返回到元素或子切片,而不进行边界检查。
///
/// 使用越界索引或当 `self` 不可解引用时调用此方法是 *[未定义行为][undefined behavior]*,即使未使用结果指针。
///
///
/// [undefined behavior]: https://doc.rust-lang.org/reference/behavior-considered-undefined.html
///
/// # Examples
///
/// ```
/// #![feature(slice_ptr_get)]
///
/// let x = &[1, 2, 4] as *const [i32];
///
/// unsafe {
/// assert_eq!(x.get_unchecked(1), x.as_ptr().add(1));
/// }
/// ```
///
#[unstable(feature = "slice_ptr_get", issue = "74265")]
#[inline]
pub unsafe fn get_unchecked<I>(self, index: I) -> *const I::Output
where
I: SliceIndex<[T]>,
{
// SAFETY: 调用者确保 `self` 是可解引用的,并且 `index` 在边界内。
unsafe { index.get_unchecked(self) }
}
/// 如果指针为空,则返回 `None`,否则返回共享切片到 `Some` 中包装的值。
/// 与 [`as_ref`] 相比,这不需要将该值初始化。
///
/// [`as_ref`]: #method.as_ref
///
/// # Safety
///
/// 调用此方法时,您必须确保要么指针是空的,要么以下所有内容都为 true:
///
/// * 指针必须为 [有效][valid] 的,才能读取许多字节的 `ptr.len() * mem::size_of::<T>()`,并且必须正确对齐。这尤其意味着:
///
/// * 整个内存范围必须包含在单个 [分配对象][allocated object] 内!
/// 切片永远不能跨越多个分配的对象。
///
/// * 即使对于零长度的切片,指针也必须对齐。
/// 这样做的一个原因是,枚举布局优化可能依赖于对齐的引用 (包括任何长度的切片) 和非空值,以将它们与其他数据区分开。
///
/// 您可以使用 [`NonNull::dangling()`] 获得可用作零长度切片的 `data` 的指针。
///
/// * 切片的总大小 `ptr.len() * mem::size_of::<T>()` 不能大于 `isize::MAX`。
/// 请参见 [`pointer::offset`] 的安全文档。
///
/// * 您必须执行 Rust 的别名规则,因为返回的生命周期 `'a` 是任意选择的,不一定反映数据的实际生命周期。
/// 特别是,当这个引用存在时,指针指向的内存不能发生可变 (`UnsafeCell` 内部除外)。
///
/// 即使未使用此方法的结果也是如此!
///
/// 另请参见 [`slice::from_raw_parts`][]。
///
/// [valid]: crate::ptr#safety
/// [allocated object]: crate::ptr#allocated-object
///
///
///
///
///
///
#[inline]
#[unstable(feature = "ptr_as_uninit", issue = "75402")]
#[rustc_const_unstable(feature = "const_ptr_as_ref", issue = "91822")]
pub const unsafe fn as_uninit_slice<'a>(self) -> Option<&'a [MaybeUninit<T>]> {
if self.is_null() {
None
} else {
// SAFETY: 调用者必须遵守 `as_uninit_slice` 的安全保证。
Some(unsafe { slice::from_raw_parts(self as *const MaybeUninit<T>, self.len()) })
}
}
}
// 指针的相等
#[stable(feature = "rust1", since = "1.0.0")]
impl<T: ?Sized> PartialEq for *const T {
#[inline]
fn eq(&self, other: &*const T) -> bool {
*self == *other
}
}
#[stable(feature = "rust1", since = "1.0.0")]
impl<T: ?Sized> Eq for *const T {}
// 指针的比较
#[stable(feature = "rust1", since = "1.0.0")]
impl<T: ?Sized> Ord for *const T {
#[inline]
fn cmp(&self, other: &*const T) -> Ordering {
if self < other {
Less
} else if self == other {
Equal
} else {
Greater
}
}
}
#[stable(feature = "rust1", since = "1.0.0")]
impl<T: ?Sized> PartialOrd for *const T {
#[inline]
fn partial_cmp(&self, other: &*const T) -> Option<Ordering> {
Some(self.cmp(other))
}
#[inline]
fn lt(&self, other: &*const T) -> bool {
*self < *other
}
#[inline]
fn le(&self, other: &*const T) -> bool {
*self <= *other
}
#[inline]
fn gt(&self, other: &*const T) -> bool {
*self > *other
}
#[inline]
fn ge(&self, other: &*const T) -> bool {
*self >= *other
}
}