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 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748
//! 单线程引用计数指针。`Rc` 代表引用计数。
//!
//! [`Rc<T>`][`Rc`] 类型提供了在堆中分配的 `T` 类型值的共享所有权。
//! 在 [`Rc`] 上调用 [`clone`][clone] 会产生一个指向堆中相同分配的新指针。
//! 当指向给定分配的最后一个 [`Rc`] 指针被销毁时,存储在该分配中的值 (通常称为 "内部值") 也将被丢弃。
//!
//! 默认情况下,Rust 中的共享引用不允许可变,[`Rc`] 也不例外:您通常无法获得 [`Rc`] 内部内容的可变引用。
//! 如果需要可变性,则将 [`Cell`] 或 [`RefCell`] 放在 [`Rc`] 内; 请参见 [`Rc` 中的可变性示例][mutability]。
//!
//! [`Rc`] 使用非原子引用计数。
//! 这意味着开销非常低,但是不能在线程之间发送 [`Rc`],因此 [`Rc`] 不实现 [`Send`]。
//! 结果,Rust 编译器将检查 *at compile time* 您是否不在线程之间发送 [`Rc`]。
//! 如果需要多线程的原子引用计数,请使用 [`sync::Arc`][arc]。
//!
//! [`downgrade`][downgrade] 方法可用于创建非所有者 [`Weak`] 指针。
//! [`Weak`] 指针可以被 [`upgrade`][upgrade] 到 [`Rc`],但是如果已经丢弃了分配中存储的值,则它将返回 [`None`]。
//! 换句话说,`Weak` 指针不会使分配内部的值保持活动状态。但是,它们确实使分配 (内部值的后备存储) 保持活动状态。
//!
//! [`Rc`] 指针之间的循环将永远不会被释放。
//! 因此,[`Weak`] 用于中断循环。
//! 例如,一棵树可以具有从父节点到子节点的强 [`Rc`] 指针,以及从子节点到其父节点的 [`Weak`] 指针。
//!
//! `Rc<T>` 自动取消对 `T` 的引用 (通过 [`Deref`] trait),因此您可以在类型为 [`Rc<T>`][`Rc`] 的值上调用 `T` 的方法。
//! 为了避免与 T 方法的名称冲突,[`Rc<T>`][`Rc`] 本身的方法是关联函数,使用 [完全限定语法][fully qualified syntax] 进行调用:
//!
//! ```
//! use std::rc::Rc;
//!
//! let my_rc = Rc::new(());
//! let my_weak = Rc::downgrade(&my_rc);
//! ```
//!
//! `RC<T> 也可以使用完全限定语法来调用 traits 的 `Clone` 等实现。
//! 有些人喜欢使用完全限定的语法,而另一些人则喜欢使用方法调用语法。
//!
//! ```
//! use std::rc::Rc;
//!
//! let rc = Rc::new(());
//! // 方法调用语法
//! let rc2 = rc.clone();
//! // 完全限定的语法
//! let rc3 = Rc::clone(&rc);
//! ```
//!
//! [`Weak<T>`][`Weak`] 不会自动解引用到 `T`,因为内部值可能已经被丢弃了。
//!
//! # 克隆引用
//!
//! 使用为 [`Rc<T>`][`Rc`] 和 [`Weak<T>`][`Weak`] 实现的 `Clone` trait,可以创建与现有引用计数指针相同分配的新引用。
//!
//!
//! ```
//! use std::rc::Rc;
//!
//! let foo = Rc::new(vec![1.0, 2.0, 3.0]);
//! // 以下两种语法是等效的。
//! let a = foo.clone();
//! let b = Rc::clone(&foo);
//! // a 和 b 都指向与 foo 相同的内存位置。
//! ```
//!
//! `Rc::clone(&from)` 语法是最常见的语法,因为它更明确地传达了代码的含义。
//! 在上面的示例中,使用此语法可以更轻松地看到此代码正在创建新的引用,而不是复制 foo 的全部内容。
//!
//! # Examples
//!
//! 考虑一个场景,其中给定的 `Owner` 拥有一组 `Gadget`。
//! 我们想让我们的 `Gadget` 指向他们的 `Owner`。我们不能用唯一的所有权来做到这一点,因为一个以上的 gadget 可能属于同一个 `Owner`。
//! [`Rc`] 允许我们在多个 `Gadget` 之间共享一个 `Owner`,并且只要有任何 `Gadget` 指向它,`Owner` 就会保持分配状态。
//!
//! ```
//! use std::rc::Rc;
//!
//! struct Owner {
//! name: String,
//! // ...其他字段
//! }
//!
//! struct Gadget {
//! id: i32,
//! owner: Rc<Owner>,
//! // ...其他字段
//! }
//!
//! fn main() {
//! // 创建一个引用计数的 `Owner`。
//! let gadget_owner: Rc<Owner> = Rc::new(
//! Owner {
//! name: "Gadget Man".to_string(),
//! }
//! );
//!
//! // 创建属于 `gadget_owner` 的 `Gadget`。
//! // 克隆 `Rc<Owner>` 为我们提供了指向同一个 `Owner` 分配的新指针,从而增加了该进程中的引用计数。
//! //
//! let gadget1 = Gadget {
//! id: 1,
//! owner: Rc::clone(&gadget_owner),
//! };
//! let gadget2 = Gadget {
//! id: 2,
//! owner: Rc::clone(&gadget_owner),
//! };
//!
//! // 处理我们的局部变量 `gadget_owner`。
//! drop(gadget_owner);
//!
//! // 尽管丢弃了 `gadget_owner`,我们仍然可以打印出 `Gadget` 的 `Owner` 的名称。
//! // 这是因为我们只删除了一个 `Rc<Owner>`,而不是它指向的 `Owner`。
//! // 只要还有其他 `Rc<Owner>` 指向相同的 `Owner` 分配,它将保持活动状态。
//! // 字段投影 `gadget1.owner.name` 之所以起作用,是因为 `Rc<Owner>` 自动取消了对 `Owner` 的引用。
//! //
//! //
//! println!("Gadget {} owned by {}", gadget1.id, gadget1.owner.name);
//! println!("Gadget {} owned by {}", gadget2.id, gadget2.owner.name);
//!
//! // 在该函数的末尾,`gadget1` 和 `gadget2` 被销毁,并且它们与我们的 `Owner` 一起被算作最后引用。
//! // `Gadget` 现在也被摧毁。
//! //
//! }
//! ```
//!
//! 如果我们的要求发生变化,并且还需要能够从 `Owner` 遍历到 `Gadget`,我们将遇到问题。
//! 从 `Owner` 到 `Gadget` 的 [`Rc`] 指针引入了一个循环。
//! 这意味着它们的引用计数永远不会达到 0,并且分配也永远不会被销毁:
//! 内存泄漏。为了解决这个问题,我们可以使用 [`Weak`] 指针。
//!
//! 实际上,Rust 使得在某种程度上很难产生此循环。为了最终得到两个指向彼此的值,其中之一必须是可变的。
//! 这很困难,因为 [`Rc`] 仅通过对其包装的值给出共享的引用来强制执行内存安全性,而这些不允许直接更改。
//! 我们需要将希望可变的的部分值包装在 [`RefCell`] 中,该值提供 *interior 可变性*: 一种通过共享引用实现可变性的方法。
//! [`RefCell`] 在运行时强制执行 Rust 的借用规则。
//!
//! ```
//! use std::rc::Rc;
//! use std::rc::Weak;
//! use std::cell::RefCell;
//!
//! struct Owner {
//! name: String,
//! gadgets: RefCell<Vec<Weak<Gadget>>>,
//! // ...其他字段
//! }
//!
//! struct Gadget {
//! id: i32,
//! owner: Rc<Owner>,
//! // ...其他字段
//! }
//!
//! fn main() {
//! // 创建一个引用计数的 `Owner`。
//! // 请注意,我们已将 `Gadget` 的所有者的 vector 放在 `RefCell` 内,以便我们可以通过共享的引用对其进行可变。
//! //
//! let gadget_owner: Rc<Owner> = Rc::new(
//! Owner {
//! name: "Gadget Man".to_string(),
//! gadgets: RefCell::new(vec![]),
//! }
//! );
//!
//! // 如前所述,创建属于 `gadget_owner` 的 `Gadget`。
//! let gadget1 = Rc::new(
//! Gadget {
//! id: 1,
//! owner: Rc::clone(&gadget_owner),
//! }
//! );
//! let gadget2 = Rc::new(
//! Gadget {
//! id: 2,
//! owner: Rc::clone(&gadget_owner),
//! }
//! );
//!
//! // 将 `Gadget` 添加到其 `Owner` 中。
//! {
//! let mut gadgets = gadget_owner.gadgets.borrow_mut();
//! gadgets.push(Rc::downgrade(&gadget1));
//! gadgets.push(Rc::downgrade(&gadget2));
//!
//! // `RefCell` 动态借用到此结束。
//! }
//!
//! // 遍历我们的 `Gadget`,将其详细信息打印出来。
//! for gadget_weak in gadget_owner.gadgets.borrow().iter() {
//!
//! // `gadget_weak` 是一个 `Weak<Gadget>`。
//! // 由于 `Weak` 指针不能保证分配仍然存在,因此我们需要调用 `upgrade`,它返回 `Option<Rc<Gadget>>`。
//! //
//! //
//! // 在这种情况下,我们知道分配仍然存在,因此我们只用 `unwrap` 和 `Option`。
//! // 在更复杂的程序中,可能需要适当的错误处理才能获得 `None` 结果。
//! //
//!
//! let gadget = gadget_weak.upgrade().unwrap();
//! println!("Gadget {} owned by {}", gadget.id, gadget.owner.name);
//! }
//!
//! // 在该函数的末尾,`gadget_owner`,`gadget1` 和 `gadget2` 被销毁。
//! // 现在没有指向该 `Gadget` 的强大 (`Rc`) 指针,因此它们已被销毁。
//! // 这会使 Gadget Man 的引用计数为零,因此他也被销毁了。
//! //
//! }
//! ```
//!
//! [clone]: Clone::clone
//! [`Cell`]: core::cell::Cell
//! [`RefCell`]: core::cell::RefCell
//! [arc]: crate::sync::Arc
//! [`Deref`]: core::ops::Deref
//! [downgrade]: Rc::downgrade
//! [upgrade]: Weak::upgrade
//! [mutability]: core::cell#introducing-mutability-inside-of-something-immutable
//! [fully qualified syntax]: https://doc.rust-lang.org/book/ch19-03-advanced-traits.html#fully-qualified-syntax-for-disambiguation-calling-methods-with-the-same-name
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
//!
#![stable(feature = "rust1", since = "1.0.0")]
#[cfg(not(test))]
use crate::boxed::Box;
#[cfg(test)]
use std::boxed::Box;
use core::any::Any;
use core::borrow;
use core::cell::Cell;
use core::cmp::Ordering;
use core::fmt;
use core::hash::{Hash, Hasher};
use core::intrinsics::abort;
#[cfg(not(no_global_oom_handling))]
use core::iter;
use core::marker::{PhantomData, Unsize};
#[cfg(not(no_global_oom_handling))]
use core::mem::size_of_val;
use core::mem::{self, align_of_val_raw, forget};
use core::ops::{CoerceUnsized, Deref, DispatchFromDyn, Receiver};
use core::panic::{RefUnwindSafe, UnwindSafe};
#[cfg(not(no_global_oom_handling))]
use core::pin::Pin;
use core::ptr::{self, NonNull};
#[cfg(not(no_global_oom_handling))]
use core::slice::from_raw_parts_mut;
#[cfg(not(no_global_oom_handling))]
use crate::alloc::handle_alloc_error;
#[cfg(not(no_global_oom_handling))]
use crate::alloc::{box_free, WriteCloneIntoRaw};
use crate::alloc::{AllocError, Allocator, Global, Layout};
use crate::borrow::{Cow, ToOwned};
#[cfg(not(no_global_oom_handling))]
use crate::string::String;
#[cfg(not(no_global_oom_handling))]
use crate::vec::Vec;
#[cfg(test)]
mod tests;
// 这是 repr(C) 为了防止未来可能的字段重新排序,否则可能会干扰可安全转换的内部类型的 _raw () 的安全性。
//
//
#[repr(C)]
struct RcBox<T: ?Sized> {
strong: Cell<usize>,
weak: Cell<usize>,
value: T,
}
/// 使用内部值的布局计算 `RcBox<T>` 的布局
fn rcbox_layout_for_value_layout(layout: Layout) -> Layout {
// 使用给定的值布局计算布局。
// 以前,在表达式 `&*(ptr as *const RcBox<T>)` 上计算布局,但是这会产生未对齐的引用 (请参见 #54908)。
//
//
Layout::new::<RcBox<()>>().extend(layout).unwrap().0.pad_to_align()
}
/// 单线程引用计数指针。`Rc` 代表引用计数。
///
/// 有关更多详细信息,请参见 [模块级文档](./index.html)。
///
/// `Rc` 的固有方法都是关联函数,这意味着您必须以例如 [`Rc::get_mut(&mut value)`][get_mut] 而不是 `value.get_mut()` 的方式调用它们。
/// 这样可以避免与内部类型 `T` 的方法发生冲突。
///
/// [get_mut]: Rc::get_mut
///
///
#[cfg_attr(not(test), rustc_diagnostic_item = "Rc")]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_insignificant_dtor]
pub struct Rc<T: ?Sized> {
ptr: NonNull<RcBox<T>>,
phantom: PhantomData<RcBox<T>>,
}
#[stable(feature = "rust1", since = "1.0.0")]
impl<T: ?Sized> !Send for Rc<T> {}
// 请注意,这个 negative impl 对于正确性来说并不是严格必要的,因为 `Rc` 传递地包含一个 `Cell`,它本身就是 `!Sync`。
// 然而,考虑到 `Rc` 的 `!Sync` 特性的重要性,有一个显式的 negative impl 对于文档来说是很好的,并且会产生更好的错误消息。
//
//
//
#[stable(feature = "rust1", since = "1.0.0")]
impl<T: ?Sized> !Sync for Rc<T> {}
#[stable(feature = "catch_unwind", since = "1.9.0")]
impl<T: RefUnwindSafe + ?Sized> UnwindSafe for Rc<T> {}
#[stable(feature = "rc_ref_unwind_safe", since = "1.58.0")]
impl<T: RefUnwindSafe + ?Sized> RefUnwindSafe for Rc<T> {}
#[unstable(feature = "coerce_unsized", issue = "18598")]
impl<T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Rc<U>> for Rc<T> {}
#[unstable(feature = "dispatch_from_dyn", issue = "none")]
impl<T: ?Sized + Unsize<U>, U: ?Sized> DispatchFromDyn<Rc<U>> for Rc<T> {}
impl<T: ?Sized> Rc<T> {
#[inline(always)]
fn inner(&self) -> &RcBox<T> {
// 这种不安全性是可以的,因为在此 Rc 处于活动状态时,我们保证内部指针有效。
//
unsafe { self.ptr.as_ref() }
}
unsafe fn from_inner(ptr: NonNull<RcBox<T>>) -> Self {
Self { ptr, phantom: PhantomData }
}
unsafe fn from_ptr(ptr: *mut RcBox<T>) -> Self {
unsafe { Self::from_inner(NonNull::new_unchecked(ptr)) }
}
}
impl<T> Rc<T> {
/// 创建一个新的 `Rc<T>`。
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let five = Rc::new(5);
/// ```
#[cfg(not(no_global_oom_handling))]
#[stable(feature = "rust1", since = "1.0.0")]
pub fn new(value: T) -> Rc<T> {
// 所有强指针都拥有一个隐式的弱指针,以确保即使强指针中存储了弱指针,弱析构函数也不会在强析构函数运行时释放分配。
//
//
//
unsafe {
Self::from_inner(
Box::leak(Box::new(RcBox { strong: Cell::new(1), weak: Cell::new(1), value }))
.into(),
)
}
}
/// 创建一个新的 `Rc<T>`,同时给您一个分配的 `Weak<T>`,以允许您创建一个 `T`,它持有一个指向自身的弱指针。
///
/// 通常,直接或间接循环引用自身的结构体不应该对自身持有强引用以防止内存泄漏。
/// 使用这个函数,您可以在 `T` 的初始化过程中,在 `Rc<T>` 创建之前访问弱指针,这样您就可以将它克隆并存储在 `T` 中。
///
/// `new_cyclic` 先给 `Rc<T>` 分配托管分配,然后调用您的闭包,给这个分配一个 `Weak<T>`,然后再把您的闭包返回的 `T` 放入分配中,完成 `Rc<T>` 的构建。
///
///
/// 由于新的 `Rc<T>` 在 `Rc<T>::new_cyclic` 返回之前尚未完全构造,因此在闭包内的弱引用上调用 [`upgrade`] 将失败并导致 `None` 值。
///
/// # Panics
///
/// 如果 `data_fn` 发生 panic,panic 会传播给调用者,而临时的 [`Weak<T>`] 会被正常丢弃。
///
/// # Examples
///
/// ```
/// # #![allow(dead_code)]
/// use std::rc::{Rc, Weak};
///
/// struct Gadget {
/// me: Weak<Gadget>,
/// }
///
/// impl Gadget {
/// /// 创建一个引用计数的 Gadget。
/// fn new() -> Rc<Self> {
/// // `me` 是指向我们正在构建的 `Rc` 的新分配的 `Weak<Gadget>`。
/////
/// Rc::new_cyclic(|me| {
/// // 在此处创建实际的结构体。
/// Gadget { me: me.clone() }
/// })
/// }
///
/// /// 返回一个指向 Self 的引用计数指针。
/// fn me(&self) -> Rc<Self> {
/// self.me.upgrade().unwrap()
/// }
/// }
/// ```
/// [`upgrade`]: Weak::upgrade
///
///
///
///
///
///
///
///
///
#[cfg(not(no_global_oom_handling))]
#[stable(feature = "arc_new_cyclic", since = "1.60.0")]
pub fn new_cyclic<F>(data_fn: F) -> Rc<T>
where
F: FnOnce(&Weak<T>) -> T,
{
// 在未初始化状态下用一个弱引用建造内部。
//
let uninit_ptr: NonNull<_> = Box::leak(Box::new(RcBox {
strong: Cell::new(0),
weak: Cell::new(1),
value: mem::MaybeUninit::<T>::uninit(),
}))
.into();
let init_ptr: NonNull<RcBox<T>> = uninit_ptr.cast();
let weak = Weak { ptr: init_ptr };
// 重要的是我们不要放弃弱指针的所有权,否则在 `data_fn` 返回时可能会释放内存。
// 如果我们真的想传递所有权,则可以为我们自己创建一个额外的弱指针,但这将导致对弱引用计数的其他更新,否则可能没有必要。
//
//
//
//
let data = data_fn(&weak);
let strong = unsafe {
let inner = init_ptr.as_ptr();
ptr::write(ptr::addr_of_mut!((*inner).value), data);
let prev_value = (*inner).strong.get();
debug_assert_eq!(prev_value, 0, "No prior strong references should exist");
(*inner).strong.set(1);
Rc::from_inner(init_ptr)
};
// 强引用应该共同拥有一个共享的弱引用,所以不要为我们的旧弱引用运行析构函数。
//
mem::forget(weak);
strong
}
/// 创建一个具有未初始化内容的新 `Rc`。
///
/// # Examples
///
/// ```
/// #![feature(new_uninit)]
/// #![feature(get_mut_unchecked)]
///
/// use std::rc::Rc;
///
/// let mut five = Rc::<u32>::new_uninit();
///
/// // 延迟初始化:
/// Rc::get_mut(&mut five).unwrap().write(5);
///
/// let five = unsafe { five.assume_init() };
///
/// assert_eq!(*five, 5)
/// ```
#[cfg(not(no_global_oom_handling))]
#[unstable(feature = "new_uninit", issue = "63291")]
#[must_use]
pub fn new_uninit() -> Rc<mem::MaybeUninit<T>> {
unsafe {
Rc::from_ptr(Rc::allocate_for_layout(
Layout::new::<T>(),
|layout| Global.allocate(layout),
|mem| mem as *mut RcBox<mem::MaybeUninit<T>>,
))
}
}
/// 创建一个具有未初始化内容的新 `Rc`,并用 `0` 字节填充内存。
///
///
/// 有关正确和不正确使用此方法的示例,请参见 [`MaybeUninit::zeroed`][zeroed]。
///
/// # Examples
///
/// ```
/// #![feature(new_uninit)]
///
/// use std::rc::Rc;
///
/// let zero = Rc::<u32>::new_zeroed();
/// let zero = unsafe { zero.assume_init() };
///
/// assert_eq!(*zero, 0)
/// ```
///
/// [zeroed]: mem::MaybeUninit::zeroed
///
#[cfg(not(no_global_oom_handling))]
#[unstable(feature = "new_uninit", issue = "63291")]
#[must_use]
pub fn new_zeroed() -> Rc<mem::MaybeUninit<T>> {
unsafe {
Rc::from_ptr(Rc::allocate_for_layout(
Layout::new::<T>(),
|layout| Global.allocate_zeroed(layout),
|mem| mem as *mut RcBox<mem::MaybeUninit<T>>,
))
}
}
/// 创建一个新的 `Rc<T>`,如果分配失败,则返回错误
///
/// # Examples
///
/// ```
/// #![feature(allocator_api)]
/// use std::rc::Rc;
///
/// let five = Rc::try_new(5);
/// # Ok::<(), std::alloc::AllocError>(())
/// ```
#[unstable(feature = "allocator_api", issue = "32838")]
pub fn try_new(value: T) -> Result<Rc<T>, AllocError> {
// 所有强指针都拥有一个隐式的弱指针,以确保即使强指针中存储了弱指针,弱析构函数也不会在强析构函数运行时释放分配。
//
//
//
unsafe {
Ok(Self::from_inner(
Box::leak(Box::try_new(RcBox { strong: Cell::new(1), weak: Cell::new(1), value })?)
.into(),
))
}
}
/// 用未初始化的内容构造一个新的 `Rc`,如果分配失败,则返回错误
///
/// # Examples
///
/// ```
/// #![feature(allocator_api, new_uninit)]
/// #![feature(get_mut_unchecked)]
///
/// use std::rc::Rc;
///
/// let mut five = Rc::<u32>::try_new_uninit()?;
///
/// // 延迟初始化:
/// Rc::get_mut(&mut five).unwrap().write(5);
///
/// let five = unsafe { five.assume_init() };
///
/// assert_eq!(*five, 5);
/// # Ok::<(), std::alloc::AllocError>(())
/// ```
#[unstable(feature = "allocator_api", issue = "32838")]
// #[unstable(feature = "new_uninit", issue = "63291")]
pub fn try_new_uninit() -> Result<Rc<mem::MaybeUninit<T>>, AllocError> {
unsafe {
Ok(Rc::from_ptr(Rc::try_allocate_for_layout(
Layout::new::<T>(),
|layout| Global.allocate(layout),
|mem| mem as *mut RcBox<mem::MaybeUninit<T>>,
)?))
}
}
/// 创建一个具有未初始化内容的新 `Rc`,并用 `0` 字节填充内存,如果分配失败,则返回错误
///
///
/// 有关正确和不正确使用此方法的示例,请参见 [`MaybeUninit::zeroed`][zeroed]。
///
/// # Examples
///
/// ```
/// #![feature(allocator_api, new_uninit)]
///
/// use std::rc::Rc;
///
/// let zero = Rc::<u32>::try_new_zeroed()?;
/// let zero = unsafe { zero.assume_init() };
///
/// assert_eq!(*zero, 0);
/// # Ok::<(), std::alloc::AllocError>(())
/// ```
///
/// [zeroed]: mem::MaybeUninit::zeroed
///
#[unstable(feature = "allocator_api", issue = "32838")]
// #[unstable(feature = "new_uninit", issue = "63291")]
pub fn try_new_zeroed() -> Result<Rc<mem::MaybeUninit<T>>, AllocError> {
unsafe {
Ok(Rc::from_ptr(Rc::try_allocate_for_layout(
Layout::new::<T>(),
|layout| Global.allocate_zeroed(layout),
|mem| mem as *mut RcBox<mem::MaybeUninit<T>>,
)?))
}
}
/// 创建一个新的 `Pin<Rc<T>>`。
/// 如果 `T` 未实现 `Unpin`,则 `value` 将被固定在内存中并且无法移动。
#[cfg(not(no_global_oom_handling))]
#[stable(feature = "pin", since = "1.33.0")]
#[must_use]
pub fn pin(value: T) -> Pin<Rc<T>> {
unsafe { Pin::new_unchecked(Rc::new(value)) }
}
/// 如果 `Rc` 正好有一个强引用,则返回内部值。
///
/// 否则,返回的 [`Err`] 将与传入的 `Rc` 相同。
///
///
/// 即使存在突出的弱引用,此操作也将成功。
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let x = Rc::new(3);
/// assert_eq!(Rc::try_unwrap(x), Ok(3));
///
/// let x = Rc::new(4);
/// let _y = Rc::clone(&x);
/// assert_eq!(*Rc::try_unwrap(x).unwrap_err(), 4);
/// ```
#[inline]
#[stable(feature = "rc_unique", since = "1.4.0")]
pub fn try_unwrap(this: Self) -> Result<T, Self> {
if Rc::strong_count(&this) == 1 {
unsafe {
let val = ptr::read(&*this); // 复制包含的对象
// 向 Weaks 表明,不能通过减少强引用计数来提升它们,然后丢弃隐式 "strong weak" 指针,同时还通过伪造 Weak 来处理放置逻辑。
//
//
//
this.inner().dec_strong();
let _weak = Weak { ptr: this.ptr };
forget(this);
Ok(val)
}
} else {
Err(this)
}
}
/// 如果 `Rc` 正好有一个强引用,则返回内部值。
///
/// 否则,返回 [`None`],`Rc` 为丢弃。
///
/// 即使存在突出的弱引用,此操作也将成功。
///
/// 如果在这个 `Rc` 的每个克隆上调用 `Rc::into_inner`,则可以保证恰好有一个调用返回内部值。
///
/// 这特别意味着内部值不是丢弃。
///
/// 这相当于 `Rc::try_unwrap(this).ok()`。
/// (请注意,由于不适用于 `Rc` 的竞争状态,这些并不等同于 [`Arc`](crate::sync::Arc)。)
#[inline]
#[stable(feature = "rc_into_inner", since = "1.70.0")]
pub fn into_inner(this: Self) -> Option<T> {
Rc::try_unwrap(this).ok()
}
}
impl<T> Rc<[T]> {
/// 创建一个新的带有未初始化内容的引用计数的切片。
///
/// # Examples
///
/// ```
/// #![feature(new_uninit)]
/// #![feature(get_mut_unchecked)]
///
/// use std::rc::Rc;
///
/// let mut values = Rc::<[u32]>::new_uninit_slice(3);
///
/// // 延迟初始化:
/// let data = Rc::get_mut(&mut values).unwrap();
/// data[0].write(1);
/// data[1].write(2);
/// data[2].write(3);
///
/// let values = unsafe { values.assume_init() };
///
/// assert_eq!(*values, [1, 2, 3])
/// ```
#[cfg(not(no_global_oom_handling))]
#[unstable(feature = "new_uninit", issue = "63291")]
#[must_use]
pub fn new_uninit_slice(len: usize) -> Rc<[mem::MaybeUninit<T>]> {
unsafe { Rc::from_ptr(Rc::allocate_for_slice(len)) }
}
/// 用未初始化的内容创建一个新的带有引用计数的切片,内存中填充 `0` 字节。
///
///
/// 有关正确和不正确使用此方法的示例,请参见 [`MaybeUninit::zeroed`][zeroed]。
///
/// # Examples
///
/// ```
/// #![feature(new_uninit)]
///
/// use std::rc::Rc;
///
/// let values = Rc::<[u32]>::new_zeroed_slice(3);
/// let values = unsafe { values.assume_init() };
///
/// assert_eq!(*values, [0, 0, 0])
/// ```
///
/// [zeroed]: mem::MaybeUninit::zeroed
///
#[cfg(not(no_global_oom_handling))]
#[unstable(feature = "new_uninit", issue = "63291")]
#[must_use]
pub fn new_zeroed_slice(len: usize) -> Rc<[mem::MaybeUninit<T>]> {
unsafe {
Rc::from_ptr(Rc::allocate_for_layout(
Layout::array::<T>(len).unwrap(),
|layout| Global.allocate_zeroed(layout),
|mem| {
ptr::slice_from_raw_parts_mut(mem as *mut T, len)
as *mut RcBox<[mem::MaybeUninit<T>]>
},
))
}
}
}
impl<T> Rc<mem::MaybeUninit<T>> {
/// 转换为 `Rc<T>`。
///
/// # Safety
///
/// 与 [`MaybeUninit::assume_init`] 一样,由调用者负责确保内部值确实处于初始化状态。
///
/// 在内容尚未完全初始化时调用此方法会立即导致未定义的行为。
///
/// [`MaybeUninit::assume_init`]: mem::MaybeUninit::assume_init
///
/// # Examples
///
/// ```
/// #![feature(new_uninit)]
/// #![feature(get_mut_unchecked)]
///
/// use std::rc::Rc;
///
/// let mut five = Rc::<u32>::new_uninit();
///
/// // 延迟初始化:
/// Rc::get_mut(&mut five).unwrap().write(5);
///
/// let five = unsafe { five.assume_init() };
///
/// assert_eq!(*five, 5)
/// ```
///
///
#[unstable(feature = "new_uninit", issue = "63291")]
#[inline]
pub unsafe fn assume_init(self) -> Rc<T> {
unsafe { Rc::from_inner(mem::ManuallyDrop::new(self).ptr.cast()) }
}
}
impl<T> Rc<[mem::MaybeUninit<T>]> {
/// 转换为 `Rc<[T]>`。
///
/// # Safety
///
/// 与 [`MaybeUninit::assume_init`] 一样,由调用者负责确保内部值确实处于初始化状态。
///
/// 在内容尚未完全初始化时调用此方法会立即导致未定义的行为。
///
/// [`MaybeUninit::assume_init`]: mem::MaybeUninit::assume_init
///
/// # Examples
///
/// ```
/// #![feature(new_uninit)]
/// #![feature(get_mut_unchecked)]
///
/// use std::rc::Rc;
///
/// let mut values = Rc::<[u32]>::new_uninit_slice(3);
///
/// // 延迟初始化:
/// let data = Rc::get_mut(&mut values).unwrap();
/// data[0].write(1);
/// data[1].write(2);
/// data[2].write(3);
///
/// let values = unsafe { values.assume_init() };
///
/// assert_eq!(*values, [1, 2, 3])
/// ```
///
///
#[unstable(feature = "new_uninit", issue = "63291")]
#[inline]
pub unsafe fn assume_init(self) -> Rc<[T]> {
unsafe { Rc::from_ptr(mem::ManuallyDrop::new(self).ptr.as_ptr() as _) }
}
}
impl<T: ?Sized> Rc<T> {
/// 消耗 `Rc`,返回包装的指针。
///
/// 为避免内存泄漏,必须使用 [`Rc::from_raw`] 将指针转换回 `Rc`。
///
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let x = Rc::new("hello".to_owned());
/// let x_ptr = Rc::into_raw(x);
/// assert_eq!(unsafe { &*x_ptr }, "hello");
/// ```
#[stable(feature = "rc_raw", since = "1.17.0")]
pub fn into_raw(this: Self) -> *const T {
let ptr = Self::as_ptr(&this);
mem::forget(this);
ptr
}
/// 为数据提供裸指针。
///
/// 计数不会受到任何影响,并且不会消耗 `Rc`。
/// 只要 `Rc` 中存在大量计数,指针就有效。
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let x = Rc::new("hello".to_owned());
/// let y = Rc::clone(&x);
/// let x_ptr = Rc::as_ptr(&x);
/// assert_eq!(x_ptr, Rc::as_ptr(&y));
/// assert_eq!(unsafe { &*x_ptr }, "hello");
/// ```
#[stable(feature = "weak_into_raw", since = "1.45.0")]
pub fn as_ptr(this: &Self) -> *const T {
let ptr: *mut RcBox<T> = NonNull::as_ptr(this.ptr);
// SAFETY: 这不能通过 Deref::deref 或 Rc::inner,因为这是保留 raw/mut 出处所必需的,例如
// 通过 `from_raw` 恢复 Rc 后,`get_mut` 可以通过指针写入。
//
unsafe { ptr::addr_of_mut!((*ptr).value) }
}
/// 从裸指针构造 `Rc<T>`。
///
/// 裸指针必须事先由调用返回到 [`Rc<U>::into_raw`][into_raw],其中 `U` 的大小和对齐方式必须与 `T` 相同。
/// 如果 `U` 是 `T`,这是很简单的。
/// 请注意,如果 `U` 不是 `T`,但是具有相同的大小和对齐方式,则基本上就像对不同类型的引用进行转换一样。
/// 有关在这种情况下适用哪些限制的更多信息,请参见 [`mem::transmute`]。
///
/// `from_raw` 的用户必须确保 `T` 的特定值仅被丢弃一次。
///
/// 此函数不安全,因为使用不当可能会导致内存不安全,即使从未访问返回的 `Rc<T>` 也是如此。
///
/// [into_raw]: Rc::into_raw
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let x = Rc::new("hello".to_owned());
/// let x_ptr = Rc::into_raw(x);
///
/// unsafe {
/// // 转换回 `Rc` 以防止泄漏。
/// let x = Rc::from_raw(x_ptr);
/// assert_eq!(&*x, "hello");
///
/// // 进一步调用 `Rc::from_raw(x_ptr)` 将导致内存不安全。
/// }
///
/// // 当 `x` 超出上面的作用域时,其内存将被释放,所以 `x_ptr` 现在悬垂了!
/// ```
///
///
///
///
///
#[stable(feature = "rc_raw", since = "1.17.0")]
pub unsafe fn from_raw(ptr: *const T) -> Self {
let offset = unsafe { data_offset(ptr) };
// 反转偏移量以找到原始的 RcBox。
let rc_ptr = unsafe { ptr.byte_sub(offset) as *mut RcBox<T> };
unsafe { Self::from_ptr(rc_ptr) }
}
/// 创建一个指向该分配的新 [`Weak`] 指针。
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let five = Rc::new(5);
///
/// let weak_five = Rc::downgrade(&five);
/// ```
#[must_use = "this returns a new `Weak` pointer, \
without modifying the original `Rc`"]
#[stable(feature = "rc_weak", since = "1.4.0")]
pub fn downgrade(this: &Self) -> Weak<T> {
this.inner().inc_weak();
// 确保我们不会创建悬垂的 Weak
debug_assert!(!is_dangling(this.ptr.as_ptr()));
Weak { ptr: this.ptr }
}
/// 获取指向该分配的 [`Weak`] 指针的数量。
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let five = Rc::new(5);
/// let _weak_five = Rc::downgrade(&five);
///
/// assert_eq!(1, Rc::weak_count(&five));
/// ```
#[inline]
#[stable(feature = "rc_counts", since = "1.15.0")]
pub fn weak_count(this: &Self) -> usize {
this.inner().weak() - 1
}
/// 获取指向此分配的强 (`Rc`) 指针的数量。
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let five = Rc::new(5);
/// let _also_five = Rc::clone(&five);
///
/// assert_eq!(2, Rc::strong_count(&five));
/// ```
#[inline]
#[stable(feature = "rc_counts", since = "1.15.0")]
pub fn strong_count(this: &Self) -> usize {
this.inner().strong()
}
/// 将与提供的指针关联的 `Rc<T>` 上的强引用计数增加 1。
///
/// # Safety
///
/// 指针必须是通过 `Rc::into_raw` 获得的,并且关联的 `Rc` 实例必须是有效的 (即
/// 在此方法的持续时间内,强引用计数必须至少为 1)。
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let five = Rc::new(5);
///
/// unsafe {
/// let ptr = Rc::into_raw(five);
/// Rc::increment_strong_count(ptr);
///
/// let five = Rc::from_raw(ptr);
/// assert_eq!(2, Rc::strong_count(&five));
/// }
/// ```
///
///
#[inline]
#[stable(feature = "rc_mutate_strong_count", since = "1.53.0")]
pub unsafe fn increment_strong_count(ptr: *const T) {
// 保留 Rc,但不要通过包装在手动丢弃中来触及引用计数
let rc = unsafe { mem::ManuallyDrop::new(Rc::<T>::from_raw(ptr)) };
// 现在增加引用计数,但也不要丢弃新的引用计数
let _rc_clone: mem::ManuallyDrop<_> = rc.clone();
}
/// 将与提供的指针关联的 `Rc<T>` 上的强引用计数减一。
///
/// # Safety
///
/// 指针必须是通过 `Rc::into_raw` 获得的,并且关联的 `Rc` 实例必须是有效的 (即
/// 调用此方法时,强引用计数必须至少为 1)。
/// 此方法可用于释放最终的 `Rc` 和后备存储,但**不应**在最终的 `Rc` 释放后调用。
///
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let five = Rc::new(5);
///
/// unsafe {
/// let ptr = Rc::into_raw(five);
/// Rc::increment_strong_count(ptr);
///
/// let five = Rc::from_raw(ptr);
/// assert_eq!(2, Rc::strong_count(&five));
/// Rc::decrement_strong_count(ptr);
/// assert_eq!(1, Rc::strong_count(&five));
/// }
/// ```
///
///
#[inline]
#[stable(feature = "rc_mutate_strong_count", since = "1.53.0")]
pub unsafe fn decrement_strong_count(ptr: *const T) {
unsafe { drop(Rc::from_raw(ptr)) };
}
/// 如果没有其他指向该分配的 `Rc` 或 [`Weak`] 指针,则返回 `true`。
///
#[inline]
fn is_unique(this: &Self) -> bool {
Rc::weak_count(this) == 0 && Rc::strong_count(this) == 1
}
/// 如果没有其他 `Rc` 或 [`Weak`] 指向相同分配的指针,则返回给定 `Rc` 的可变引用。
///
///
/// 否则返回 [`None`],因为更改共享值并不安全。
///
/// 另请参见 [`make_mut`][make_mut],当有其他 `Rc` 指针时,它将 [`clone`][clone] 内部值。
///
/// [make_mut]: Rc::make_mut
/// [clone]: Clone::clone
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let mut x = Rc::new(3);
/// *Rc::get_mut(&mut x).unwrap() = 4;
/// assert_eq!(*x, 4);
///
/// let _y = Rc::clone(&x);
/// assert!(Rc::get_mut(&mut x).is_none());
/// ```
///
///
#[inline]
#[stable(feature = "rc_unique", since = "1.4.0")]
pub fn get_mut(this: &mut Self) -> Option<&mut T> {
if Rc::is_unique(this) { unsafe { Some(Rc::get_mut_unchecked(this)) } } else { None }
}
/// 将变量引用返回给定的 `Rc`,而不进行任何检查。
///
/// 另请参见 [`get_mut`],它是安全的并且进行适当的检查。
///
/// [`get_mut`]: Rc::get_mut
///
/// # Safety
///
/// 如果存在指向同一分配的任何其他 `Rc` 或 [`Weak`] 指针,则在返回的借用期间,它们不得被解引用或具有活动借用,并且它们的内部类型必须与此 Rc 的内部类型完全相同 (包括生命周)。
/// 如果不存在这样的指针 (例如紧接在 `Rc::new` 之后),则情况很简单。
///
/// # Examples
///
/// ```
/// #![feature(get_mut_unchecked)]
///
/// use std::rc::Rc;
///
/// let mut x = Rc::new(String::new());
/// unsafe {
/// Rc::get_mut_unchecked(&mut x).push_str("foo")
/// }
/// assert_eq!(*x, "foo");
/// ```
/// 指向同一分配的其他 `Rc` 指针必须指向同一类型。
///
/// ```no_run
/// #![feature(get_mut_unchecked)]
///
/// use std::rc::Rc;
///
/// let x: Rc<str> = Rc::from("Hello, world!");
/// let mut y: Rc<[u8]> = x.clone().into();
/// unsafe {
/// // 这是未定义的行为,因为 x 的内部类型是 str,而不是 [u8]
/// Rc::get_mut_unchecked(&mut y).fill(0xff); // 0xff 在 UTF-8 中无效
/// }
/// println!("{}", &*x); // str 中的 UTF-8 无效
/// ```
///
/// 指向同一分配的其他 `Rc` 指针必须指向完全相同的类型,包括生命周期。
///
/// ```no_run
/// #![feature(get_mut_unchecked)]
///
/// use std::rc::Rc;
///
/// let x: Rc<&str> = Rc::new("Hello, world!");
/// {
/// let s = String::from("Oh, no!");
/// let mut y: Rc<&str> = x.clone().into();
/// unsafe {
/// // 这是未定义的行为,因为 x 的内部类型是 &'long str,而不是 &'short str
/////
/// *Rc::get_mut_unchecked(&mut y) = &s;
/// }
/// }
/// println!("{}", &*x); // Use-after-free
/// ```
///
#[inline]
#[unstable(feature = "get_mut_unchecked", issue = "63292")]
pub unsafe fn get_mut_unchecked(this: &mut Self) -> &mut T {
// 我们小心 *不要* 创建覆盖 "count" 字段的引用,因为这会与对引用计数的访问产生冲突 (例如
// 由 `Weak`)。
unsafe { &mut (*this.ptr.as_ptr()).value }
}
#[inline]
#[stable(feature = "ptr_eq", since = "1.17.0")]
/// 如果两个 `Rc` 以类似于 [`ptr::eq`] 的方式指向相同的分配,则返回 `true`。
/// 比较 `dyn Trait` 指针时的注意事项,请参见 [that function][`ptr::eq`]。
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let five = Rc::new(5);
/// let same_five = Rc::clone(&five);
/// let other_five = Rc::new(5);
///
/// assert!(Rc::ptr_eq(&five, &same_five));
/// assert!(!Rc::ptr_eq(&five, &other_five));
/// ```
pub fn ptr_eq(this: &Self, other: &Self) -> bool {
this.ptr.as_ptr() == other.ptr.as_ptr()
}
}
impl<T: Clone> Rc<T> {
/// 对给定的 `Rc` 进行可变引用。
///
/// 如果还有其他指向同一分配的 `Rc` 指针,则 `make_mut` 会将 [`clone`] 的内部值分配给新分配,以确保唯一的所有权。
/// 这也称为写时克隆。
///
/// 但是,如果没有其他指向此分配的 `Rc` 指针,而是一些 [`Weak`] 指针,则 [`Weak`] 指针将被解除关联,并且不会克隆内部值。
///
///
/// 另请参见 [`get_mut`],它将失败而不是克隆内部值或解除 [`Weak`] 指针的关联。
///
/// [`clone`]: Clone::clone
/// [`get_mut`]: Rc::get_mut
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let mut data = Rc::new(5);
///
/// *Rc::make_mut(&mut data) += 1; // 不会克隆任何东西
/// let mut other_data = Rc::clone(&data); // 不会克隆内部数据
/// *Rc::make_mut(&mut data) += 1; // 克隆内部数据
/// *Rc::make_mut(&mut data) += 1; // 不会克隆任何东西
/// *Rc::make_mut(&mut other_data) *= 2; // 不会克隆任何东西
///
/// // 现在,`data` 和 `other_data` 指向不同的分配。
/// assert_eq!(*data, 8);
/// assert_eq!(*other_data, 12);
/// ```
///
/// [`Weak`] 指针将被解除关联:
///
/// ```
/// use std::rc::Rc;
///
/// let mut data = Rc::new(75);
/// let weak = Rc::downgrade(&data);
///
/// assert!(75 == *data);
/// assert!(75 == *weak.upgrade().unwrap());
///
/// *Rc::make_mut(&mut data) += 1;
///
/// assert!(76 == *data);
/// assert!(weak.upgrade().is_none());
/// ```
///
///
///
#[cfg(not(no_global_oom_handling))]
#[inline]
#[stable(feature = "rc_unique", since = "1.4.0")]
pub fn make_mut(this: &mut Self) -> &mut T {
if Rc::strong_count(this) != 1 {
// 要克隆数据,还有其他 Rcs。
// 预分配内存以允许直接写入克隆的值。
let mut rc = Self::new_uninit();
unsafe {
let data = Rc::get_mut_unchecked(&mut rc);
(**this).write_clone_into_raw(data.as_mut_ptr());
*this = rc.assume_init();
}
} else if Rc::weak_count(this) != 0 {
// 只能窃取数据,剩下的就是 Weaks
let mut rc = Self::new_uninit();
unsafe {
let data = Rc::get_mut_unchecked(&mut rc);
data.as_mut_ptr().copy_from_nonoverlapping(&**this, 1);
this.inner().dec_strong();
// 删除隐式的强弱引用 (无需在此处制作假的弱项 - 我们知道其他弱项也可以为我们清除)
//
this.inner().dec_weak();
ptr::write(this, rc.assume_init());
}
}
// 这种不安全性是可以的,因为我们保证返回的指针是将永远返回到 T 的 *only* 指针。
// 此时我们的引用计数保证为 1,并且我们要求 `Rc<T>` 本身为 `mut`,因此我们将唯一可能的引用返回给分配。
//
//
//
unsafe { &mut this.ptr.as_mut().value }
}
/// 如果我们有 `T` 的唯一引用,那就打开它。否则,克隆 `T` 并返回克隆。
///
/// 假设 `rc_t` 是 `Rc<T>` 类型,这个函数在功能上等同于 `(*rc_t).clone()`,但会尽可能避免克隆内部值。
///
///
/// # Examples
///
/// ```
/// #![feature(arc_unwrap_or_clone)]
/// # use std::{ptr, rc::Rc};
/// let inner = String::from("test");
/// let ptr = inner.as_ptr();
///
/// let rc = Rc::new(inner);
/// let inner = Rc::unwrap_or_clone(rc);
/// // 内部值没有被克隆
/// assert!(ptr::eq(ptr, inner.as_ptr()));
///
/// let rc = Rc::new(inner);
/// let rc2 = rc.clone();
/// let inner = Rc::unwrap_or_clone(rc);
/// // 因为有两个引用,我们不得不克隆内部值。
/// assert!(!ptr::eq(ptr, inner.as_ptr()));
/// // `rc2` 是最后一个引用,所以当我们打开它时,我们会得到原来的 `String`。
/////
/// let inner = Rc::unwrap_or_clone(rc2);
/// assert!(ptr::eq(ptr, inner.as_ptr()));
/// ```
///
#[inline]
#[unstable(feature = "arc_unwrap_or_clone", issue = "93610")]
pub fn unwrap_or_clone(this: Self) -> T {
Rc::try_unwrap(this).unwrap_or_else(|rc| (*rc).clone())
}
}
impl Rc<dyn Any> {
/// 尝试将 `Rc<dyn Any>` 转换为具体类型。
///
/// # Examples
///
/// ```
/// use std::any::Any;
/// use std::rc::Rc;
///
/// fn print_if_string(value: Rc<dyn Any>) {
/// if let Ok(string) = value.downcast::<String>() {
/// println!("String ({}): {}", string.len(), string);
/// }
/// }
///
/// let my_string = "Hello World".to_string();
/// print_if_string(Rc::new(my_string));
/// print_if_string(Rc::new(0i8));
/// ```
#[inline]
#[stable(feature = "rc_downcast", since = "1.29.0")]
pub fn downcast<T: Any>(self) -> Result<Rc<T>, Rc<dyn Any>> {
if (*self).is::<T>() {
unsafe {
let ptr = self.ptr.cast::<RcBox<T>>();
forget(self);
Ok(Rc::from_inner(ptr))
}
} else {
Err(self)
}
}
/// 将 `Rc<dyn Any>` 向下转换为具体类型。
///
/// 有关安全的替代方案,请参见 [`downcast`]。
///
/// # Examples
///
/// ```
/// #![feature(downcast_unchecked)]
///
/// use std::any::Any;
/// use std::rc::Rc;
///
/// let x: Rc<dyn Any> = Rc::new(1_usize);
///
/// unsafe {
/// assert_eq!(*x.downcast_unchecked::<usize>(), 1);
/// }
/// ```
///
/// # Safety
///
/// 包含的值必须是 `T` 类型。
/// 使用不正确的类型调用此方法是 *未定义的行为*。
///
///
/// [`downcast`]: Self::downcast
#[inline]
#[unstable(feature = "downcast_unchecked", issue = "90850")]
pub unsafe fn downcast_unchecked<T: Any>(self) -> Rc<T> {
unsafe {
let ptr = self.ptr.cast::<RcBox<T>>();
mem::forget(self);
Rc::from_inner(ptr)
}
}
}
impl<T: ?Sized> Rc<T> {
/// 为 `RcBox<T>` 分配足够的空间,以容纳可能未定义大小的内部值,其中该值具有提供的布局。
///
/// 函数 `mem_to_rcbox` 用数据指针调用,并且必须返回 `RcBox<T>` 的 (可能是胖的) 指针。
///
///
#[cfg(not(no_global_oom_handling))]
unsafe fn allocate_for_layout(
value_layout: Layout,
allocate: impl FnOnce(Layout) -> Result<NonNull<[u8]>, AllocError>,
mem_to_rcbox: impl FnOnce(*mut u8) -> *mut RcBox<T>,
) -> *mut RcBox<T> {
let layout = rcbox_layout_for_value_layout(value_layout);
unsafe {
Rc::try_allocate_for_layout(value_layout, allocate, mem_to_rcbox)
.unwrap_or_else(|_| handle_alloc_error(layout))
}
}
/// 为 `RcBox<T>` 分配足够的空间,以容纳可能未定义大小的内部值 (该值具有提供的布局),如果分配失败,则返回错误。
///
///
/// 函数 `mem_to_rcbox` 用数据指针调用,并且必须返回 `RcBox<T>` 的 (可能是胖的) 指针。
///
///
#[inline]
unsafe fn try_allocate_for_layout(
value_layout: Layout,
allocate: impl FnOnce(Layout) -> Result<NonNull<[u8]>, AllocError>,
mem_to_rcbox: impl FnOnce(*mut u8) -> *mut RcBox<T>,
) -> Result<*mut RcBox<T>, AllocError> {
let layout = rcbox_layout_for_value_layout(value_layout);
// 为布局分配。
let ptr = allocate(layout)?;
// 初始化 RcBox
let inner = mem_to_rcbox(ptr.as_non_null_ptr().as_ptr());
unsafe {
debug_assert_eq!(Layout::for_value(&*inner), layout);
ptr::write(&mut (*inner).strong, Cell::new(1));
ptr::write(&mut (*inner).weak, Cell::new(1));
}
Ok(inner)
}
/// 为 `RcBox` 分配足够的空间,以容纳未定义大小的内部值
#[cfg(not(no_global_oom_handling))]
unsafe fn allocate_for_ptr(ptr: *const T) -> *mut RcBox<T> {
// 使用给定的值分配 `RcBox<T>`。
unsafe {
Self::allocate_for_layout(
Layout::for_value(&*ptr),
|layout| Global.allocate(layout),
|mem| mem.with_metadata_of(ptr as *const RcBox<T>),
)
}
}
#[cfg(not(no_global_oom_handling))]
fn from_box(v: Box<T>) -> Rc<T> {
unsafe {
let (box_unique, alloc) = Box::into_unique(v);
let bptr = box_unique.as_ptr();
let value_size = size_of_val(&*bptr);
let ptr = Self::allocate_for_ptr(bptr);
// 将值复制为字节
ptr::copy_nonoverlapping(
bptr as *const T as *const u8,
&mut (*ptr).value as *mut _ as *mut u8,
value_size,
);
// 释放分配而不丢弃其内容
box_free(box_unique, alloc);
Self::from_ptr(ptr)
}
}
}
impl<T> Rc<[T]> {
/// 用给定的长度分配 `RcBox<[T]>`。
#[cfg(not(no_global_oom_handling))]
unsafe fn allocate_for_slice(len: usize) -> *mut RcBox<[T]> {
unsafe {
Self::allocate_for_layout(
Layout::array::<T>(len).unwrap(),
|layout| Global.allocate(layout),
|mem| ptr::slice_from_raw_parts_mut(mem as *mut T, len) as *mut RcBox<[T]>,
)
}
}
/// 将切片中的元素复制到新分配的 `Rc<[T]>`
///
/// 不安全,因为调用者必须拥有所有权或绑定 `T: Copy`
#[cfg(not(no_global_oom_handling))]
unsafe fn copy_from_slice(v: &[T]) -> Rc<[T]> {
unsafe {
let ptr = Self::allocate_for_slice(v.len());
ptr::copy_nonoverlapping(v.as_ptr(), &mut (*ptr).value as *mut [T] as *mut T, v.len());
Self::from_ptr(ptr)
}
}
/// 从已知为一定大小的迭代器构造 `Rc<[T]>`。
///
/// 如果大小错误,则行为是未定义的。
#[cfg(not(no_global_oom_handling))]
unsafe fn from_iter_exact(iter: impl Iterator<Item = T>, len: usize) -> Rc<[T]> {
// 在克隆 T 元素时 panic 守卫。
// 如果出现 panic,将丢弃已写入新 RcBox 的元素,然后释放内存。
//
struct Guard<T> {
mem: NonNull<u8>,
elems: *mut T,
layout: Layout,
n_elems: usize,
}
impl<T> Drop for Guard<T> {
fn drop(&mut self) {
unsafe {
let slice = from_raw_parts_mut(self.elems, self.n_elems);
ptr::drop_in_place(slice);
Global.deallocate(self.mem, self.layout);
}
}
}
unsafe {
let ptr = Self::allocate_for_slice(len);
let mem = ptr as *mut _ as *mut u8;
let layout = Layout::for_value(&*ptr);
// 指向第一个元素的指针
let elems = &mut (*ptr).value as *mut [T] as *mut T;
let mut guard = Guard { mem: NonNull::new_unchecked(mem), elems, layout, n_elems: 0 };
for (i, item) in iter.enumerate() {
ptr::write(elems.add(i), item);
guard.n_elems += 1;
}
// 全部清空。忘记守卫,这样它就不会释放新的 RcBox。
forget(guard);
Self::from_ptr(ptr)
}
}
}
/// 用于 `From<&[T]>` 使用的专业化 trait。
trait RcFromSlice<T> {
fn from_slice(slice: &[T]) -> Self;
}
#[cfg(not(no_global_oom_handling))]
impl<T: Clone> RcFromSlice<T> for Rc<[T]> {
#[inline]
default fn from_slice(v: &[T]) -> Self {
unsafe { Self::from_iter_exact(v.iter().cloned(), v.len()) }
}
}
#[cfg(not(no_global_oom_handling))]
impl<T: Copy> RcFromSlice<T> for Rc<[T]> {
#[inline]
fn from_slice(v: &[T]) -> Self {
unsafe { Rc::copy_from_slice(v) }
}
}
#[stable(feature = "rust1", since = "1.0.0")]
impl<T: ?Sized> Deref for Rc<T> {
type Target = T;
#[inline(always)]
fn deref(&self) -> &T {
&self.inner().value
}
}
#[unstable(feature = "receiver_trait", issue = "none")]
impl<T: ?Sized> Receiver for Rc<T> {}
#[stable(feature = "rust1", since = "1.0.0")]
unsafe impl<#[may_dangle] T: ?Sized> Drop for Rc<T> {
/// 丢弃 `Rc`。
///
/// 这将减少强引用计数。
/// 如果强引用计数达到零,那么唯一的其他引用 (如果有) 是 [`Weak`],因此我们将 `drop` 作为内部值。
///
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// struct Foo;
///
/// impl Drop for Foo {
/// fn drop(&mut self) {
/// println!("dropped!");
/// }
/// }
///
/// let foo = Rc::new(Foo);
/// let foo2 = Rc::clone(&foo);
///
/// drop(foo); // 不打印任何东西
/// drop(foo2); // 打印 "dropped!"
/// ```
fn drop(&mut self) {
unsafe {
self.inner().dec_strong();
if self.inner().strong() == 0 {
// 销毁所包含的对象
ptr::drop_in_place(Self::get_mut_unchecked(self));
// 现在我们已经销毁了内容,请删除隐式 "strong weak" 指针。
//
self.inner().dec_weak();
if self.inner().weak() == 0 {
Global.deallocate(self.ptr.cast(), Layout::for_value(self.ptr.as_ref()));
}
}
}
}
}
#[stable(feature = "rust1", since = "1.0.0")]
impl<T: ?Sized> Clone for Rc<T> {
/// 克隆 `Rc` 指针。
///
/// 这将创建另一个指向相同分配的指针,从而增加了强引用计数。
///
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let five = Rc::new(5);
///
/// let _ = Rc::clone(&five);
/// ```
#[inline]
fn clone(&self) -> Rc<T> {
unsafe {
self.inner().inc_strong();
Self::from_inner(self.ptr)
}
}
}
#[cfg(not(no_global_oom_handling))]
#[stable(feature = "rust1", since = "1.0.0")]
impl<T: Default> Default for Rc<T> {
/// 用 `T` 的 `Default` 值创建一个新的 `Rc<T>`。
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let x: Rc<i32> = Default::default();
/// assert_eq!(*x, 0);
/// ```
#[inline]
fn default() -> Rc<T> {
Rc::new(Default::default())
}
}
#[stable(feature = "rust1", since = "1.0.0")]
trait RcEqIdent<T: ?Sized + PartialEq> {
fn eq(&self, other: &Rc<T>) -> bool;
fn ne(&self, other: &Rc<T>) -> bool;
}
#[stable(feature = "rust1", since = "1.0.0")]
impl<T: ?Sized + PartialEq> RcEqIdent<T> for Rc<T> {
#[inline]
default fn eq(&self, other: &Rc<T>) -> bool {
**self == **other
}
#[inline]
default fn ne(&self, other: &Rc<T>) -> bool {
**self != **other
}
}
// 即使 `Eq` 有一种方法,也可以允许专门研究 `Eq`。
#[rustc_unsafe_specialization_marker]
pub(crate) trait MarkerEq: PartialEq<Self> {}
impl<T: Eq> MarkerEq for T {}
/// 我们在这里进行这种专门化,而不是对 `&T` 进行更一般的优化,因为否则会增加对引用的所有相等性检查的成本。
/// 我们假设 `Rc`s 用于存储较大的值,这些值克隆起来较慢,但在检查相等性时又很繁琐,从而使此成本更容易得到回报。
///
/// 与两个 `&T` 相比,它更有可能具有两个指向相同值的 `Rc` 克隆。
///
/// 仅当 `T: Eq` 作为 `PartialEq` 可能是故意的非反射时,我们才能这样做。
///
#[stable(feature = "rust1", since = "1.0.0")]
impl<T: ?Sized + MarkerEq> RcEqIdent<T> for Rc<T> {
#[inline]
fn eq(&self, other: &Rc<T>) -> bool {
Rc::ptr_eq(self, other) || **self == **other
}
#[inline]
fn ne(&self, other: &Rc<T>) -> bool {
!Rc::ptr_eq(self, other) && **self != **other
}
}
#[stable(feature = "rust1", since = "1.0.0")]
impl<T: ?Sized + PartialEq> PartialEq for Rc<T> {
/// 两个 Rc 相等。
///
/// 即使两个 `Rc` 的内部值相等,即使它们存储在不同的分配中,它们也相等。
///
/// 如果 `T` 还实现了 `Eq` (暗示相等的反射性),则指向同一分配的两个 `Rc' 始终相等。
///
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let five = Rc::new(5);
///
/// assert!(five == Rc::new(5));
/// ```
///
///
#[inline]
fn eq(&self, other: &Rc<T>) -> bool {
RcEqIdent::eq(self, other)
}
/// 两个 `Rc` 的不等式。
///
/// 如果两个 Rc 的内部值不相等,则它们不相等。
///
/// 如果 `T` 还实现了 `Eq` (暗示相等的反射性),则指向同一分配的两个 `Rc' 始终相等。
///
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let five = Rc::new(5);
///
/// assert!(five != Rc::new(6));
/// ```
///
#[inline]
fn ne(&self, other: &Rc<T>) -> bool {
RcEqIdent::ne(self, other)
}
}
#[stable(feature = "rust1", since = "1.0.0")]
impl<T: ?Sized + Eq> Eq for Rc<T> {}
#[stable(feature = "rust1", since = "1.0.0")]
impl<T: ?Sized + PartialOrd> PartialOrd for Rc<T> {
/// 两个 `Rc` 的部分比较。
///
/// 通过调用 `partial_cmp()` 的内部值来比较两者。
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
/// use std::cmp::Ordering;
///
/// let five = Rc::new(5);
///
/// assert_eq!(Some(Ordering::Less), five.partial_cmp(&Rc::new(6)));
/// ```
#[inline(always)]
fn partial_cmp(&self, other: &Rc<T>) -> Option<Ordering> {
(**self).partial_cmp(&**other)
}
/// 小于两个 Rc 的比较。
///
/// 通过调用 `<` 的内部值来比较两者。
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let five = Rc::new(5);
///
/// assert!(five < Rc::new(6));
/// ```
#[inline(always)]
fn lt(&self, other: &Rc<T>) -> bool {
**self < **other
}
/// 两个 `Rc` 的小于或等于比较。
///
/// 通过调用 `<=` 的内部值来比较两者。
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let five = Rc::new(5);
///
/// assert!(five <= Rc::new(5));
/// ```
#[inline(always)]
fn le(&self, other: &Rc<T>) -> bool {
**self <= **other
}
/// 大于两个 Rc 的比较。
///
/// 通过调用 `>` 的内部值来比较两者。
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let five = Rc::new(5);
///
/// assert!(five > Rc::new(4));
/// ```
#[inline(always)]
fn gt(&self, other: &Rc<T>) -> bool {
**self > **other
}
/// 两个 `Rc` 的大于或等于比较。
///
/// 通过调用 `>=` 的内部值来比较两者。
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let five = Rc::new(5);
///
/// assert!(five >= Rc::new(5));
/// ```
#[inline(always)]
fn ge(&self, other: &Rc<T>) -> bool {
**self >= **other
}
}
#[stable(feature = "rust1", since = "1.0.0")]
impl<T: ?Sized + Ord> Ord for Rc<T> {
/// 两个 `Rc` 的比较。
///
/// 通过调用 `cmp()` 的内部值来比较两者。
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
/// use std::cmp::Ordering;
///
/// let five = Rc::new(5);
///
/// assert_eq!(Ordering::Less, five.cmp(&Rc::new(6)));
/// ```
#[inline]
fn cmp(&self, other: &Rc<T>) -> Ordering {
(**self).cmp(&**other)
}
}
#[stable(feature = "rust1", since = "1.0.0")]
impl<T: ?Sized + Hash> Hash for Rc<T> {
fn hash<H: Hasher>(&self, state: &mut H) {
(**self).hash(state);
}
}
#[stable(feature = "rust1", since = "1.0.0")]
impl<T: ?Sized + fmt::Display> fmt::Display for Rc<T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Display::fmt(&**self, f)
}
}
#[stable(feature = "rust1", since = "1.0.0")]
impl<T: ?Sized + fmt::Debug> fmt::Debug for Rc<T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Debug::fmt(&**self, f)
}
}
#[stable(feature = "rust1", since = "1.0.0")]
impl<T: ?Sized> fmt::Pointer for Rc<T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Pointer::fmt(&(&**self as *const T), f)
}
}
#[cfg(not(no_global_oom_handling))]
#[stable(feature = "from_for_ptrs", since = "1.6.0")]
impl<T> From<T> for Rc<T> {
/// 泛型 `T` 改装成 `Rc<T>`
///
/// 转换在堆上分配,并将 `t` 从栈移到堆中。
///
/// # Example
///
/// ```rust
/// # use std::rc::Rc;
/// let x = 5;
/// let rc = Rc::new(5);
///
/// assert_eq!(Rc::from(x), rc);
/// ```
fn from(t: T) -> Self {
Rc::new(t)
}
}
#[cfg(not(no_global_oom_handling))]
#[stable(feature = "shared_from_slice", since = "1.21.0")]
impl<T: Clone> From<&[T]> for Rc<[T]> {
/// 分配一个引用计数的切片,并通过克隆 `v` 的项来填充它。
///
/// # Example
///
/// ```
/// # use std::rc::Rc;
/// let original: &[i32] = &[1, 2, 3];
/// let shared: Rc<[i32]> = Rc::from(original);
/// assert_eq!(&[1, 2, 3], &shared[..]);
/// ```
#[inline]
fn from(v: &[T]) -> Rc<[T]> {
<Self as RcFromSlice<T>>::from_slice(v)
}
}
#[cfg(not(no_global_oom_handling))]
#[stable(feature = "shared_from_slice", since = "1.21.0")]
impl From<&str> for Rc<str> {
/// 分配一个引用计数的字符串切片并将 `v` 复制到其中。
///
/// # Example
///
/// ```
/// # use std::rc::Rc;
/// let shared: Rc<str> = Rc::from("statue");
/// assert_eq!("statue", &shared[..]);
/// ```
#[inline]
fn from(v: &str) -> Rc<str> {
let rc = Rc::<[u8]>::from(v.as_bytes());
unsafe { Rc::from_raw(Rc::into_raw(rc) as *const str) }
}
}
#[cfg(not(no_global_oom_handling))]
#[stable(feature = "shared_from_slice", since = "1.21.0")]
impl From<String> for Rc<str> {
/// 分配一个引用计数的字符串切片并将 `v` 复制到其中。
///
/// # Example
///
/// ```
/// # use std::rc::Rc;
/// let original: String = "statue".to_owned();
/// let shared: Rc<str> = Rc::from(original);
/// assert_eq!("statue", &shared[..]);
/// ```
#[inline]
fn from(v: String) -> Rc<str> {
Rc::from(&v[..])
}
}
#[cfg(not(no_global_oom_handling))]
#[stable(feature = "shared_from_slice", since = "1.21.0")]
impl<T: ?Sized> From<Box<T>> for Rc<T> {
/// 将 boxed 对象移动到引用计数的新分配。
///
/// # Example
///
/// ```
/// # use std::rc::Rc;
/// let original: Box<i32> = Box::new(1);
/// let shared: Rc<i32> = Rc::from(original);
/// assert_eq!(1, *shared);
/// ```
#[inline]
fn from(v: Box<T>) -> Rc<T> {
Rc::from_box(v)
}
}
#[cfg(not(no_global_oom_handling))]
#[stable(feature = "shared_from_slice", since = "1.21.0")]
impl<T> From<Vec<T>> for Rc<[T]> {
/// 分配一个引用计数的切片,并将 `v` 的项移入其中。
///
/// # Example
///
/// ```
/// # use std::rc::Rc;
/// let original: Box<Vec<i32>> = Box::new(vec![1, 2, 3]);
/// let shared: Rc<Vec<i32>> = Rc::from(original);
/// assert_eq!(vec![1, 2, 3], *shared);
/// ```
#[inline]
fn from(mut v: Vec<T>) -> Rc<[T]> {
unsafe {
let rc = Rc::copy_from_slice(&v);
// 允许 Vec 释放其内存,但不销毁其内容
v.set_len(0);
rc
}
}
}
#[stable(feature = "shared_from_cow", since = "1.45.0")]
impl<'a, B> From<Cow<'a, B>> for Rc<B>
where
B: ToOwned + ?Sized,
Rc<B>: From<&'a B> + From<B::Owned>,
{
/// 通过复制其内容,从写时克隆指针创建一个引用计数指针。
///
///
/// # Example
///
/// ```rust
/// # use std::rc::Rc;
/// # use std::borrow::Cow;
/// let cow: Cow<'_, str> = Cow::Borrowed("eggplant");
/// let shared: Rc<str> = Rc::from(cow);
/// assert_eq!("eggplant", &shared[..]);
/// ```
#[inline]
fn from(cow: Cow<'a, B>) -> Rc<B> {
match cow {
Cow::Borrowed(s) => Rc::from(s),
Cow::Owned(s) => Rc::from(s),
}
}
}
#[stable(feature = "shared_from_str", since = "1.62.0")]
impl From<Rc<str>> for Rc<[u8]> {
/// 将引用计数的字符串切片转换为字节切片。
///
/// # Example
///
/// ```
/// # use std::rc::Rc;
/// let string: Rc<str> = Rc::from("eggplant");
/// let bytes: Rc<[u8]> = Rc::from(string);
/// assert_eq!("eggplant".as_bytes(), bytes.as_ref());
/// ```
#[inline]
fn from(rc: Rc<str>) -> Self {
// SAFETY: `str` 与 `[u8]` 具有相同的布局。
unsafe { Rc::from_raw(Rc::into_raw(rc) as *const [u8]) }
}
}
#[stable(feature = "boxed_slice_try_from", since = "1.43.0")]
impl<T, const N: usize> TryFrom<Rc<[T]>> for Rc<[T; N]> {
type Error = Rc<[T]>;
fn try_from(boxed_slice: Rc<[T]>) -> Result<Self, Self::Error> {
if boxed_slice.len() == N {
Ok(unsafe { Rc::from_raw(Rc::into_raw(boxed_slice) as *mut [T; N]) })
} else {
Err(boxed_slice)
}
}
}
#[cfg(not(no_global_oom_handling))]
#[stable(feature = "shared_from_iter", since = "1.37.0")]
impl<T> FromIterator<T> for Rc<[T]> {
/// 获取 `Iterator` 中的每个元素,并将其收集到 `Rc<[T]>` 中。
///
/// # 性能特点
///
/// ## 一般情况
///
/// 在一般情况下,首先要收集到 `Vec<T>` 中来收集到 `Rc<[T]>` 中。也就是说,编写以下内容时:
///
/// ```rust
/// # use std::rc::Rc;
/// let evens: Rc<[u8]> = (0..10).filter(|&x| x % 2 == 0).collect();
/// # assert_eq!(&*evens, &[0, 2, 4, 6, 8]);
/// ```
///
/// 这就像我们写的那样:
///
/// ```rust
/// # use std::rc::Rc;
/// let evens: Rc<[u8]> = (0..10).filter(|&x| x % 2 == 0)
/// .collect::<Vec<_>>() // 第一组分配在此处发生。
/// .into(); // `Rc<[T]>` 的第二个分配在此处进行。
/// # assert_eq!(&*evens, &[0, 2, 4, 6, 8]);
/// ```
///
/// 这将分配构造 `Vec<T>` 所需的次数,然后分配一次,以将 `Vec<T>` 转换为 `Rc<[T]>`。
///
///
/// ## 已知长度的迭代器
///
/// 当您的 `Iterator` 实现 `TrustedLen` 且大小正确时,将为 `Rc<[T]>` 进行一次分配。例如:
///
/// ```rust
/// # use std::rc::Rc;
/// let evens: Rc<[u8]> = (0..10).collect(); // 这里只进行一次分配。
/// # assert_eq!(&*evens, &*(0..10).collect::<Vec<_>>());
/// ```
///
///
fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self {
ToRcSlice::to_rc_slice(iter.into_iter())
}
}
/// 专门的 trait 用于收集到 `Rc<[T]>` 中。
#[cfg(not(no_global_oom_handling))]
trait ToRcSlice<T>: Iterator<Item = T> + Sized {
fn to_rc_slice(self) -> Rc<[T]>;
}
#[cfg(not(no_global_oom_handling))]
impl<T, I: Iterator<Item = T>> ToRcSlice<T> for I {
default fn to_rc_slice(self) -> Rc<[T]> {
self.collect::<Vec<T>>().into()
}
}
#[cfg(not(no_global_oom_handling))]
impl<T, I: iter::TrustedLen<Item = T>> ToRcSlice<T> for I {
fn to_rc_slice(self) -> Rc<[T]> {
// `TrustedLen` 迭代器就是这种情况。
let (low, high) = self.size_hint();
if let Some(high) = high {
debug_assert_eq!(
low,
high,
"TrustedLen iterator's size hint is not exact: {:?}",
(low, high)
);
unsafe {
// SAFETY: 我们需要确保迭代器有一个精确的长度,并且我们有。
Rc::from_iter_exact(self, low)
}
} else {
// TrustedLen 契约保证 `upper_bound == None` 意味着迭代器长度超过 `usize::MAX`。
//
// 默认实现将收集到一个 vec 中,这将是 panic。
// 因此,我们立即在此处 panic 而不调用 `Vec` 代码。
panic!("capacity overflow");
}
}
}
/// `Weak` 是 [`Rc`] 的一个版本,它持有对托管分配的非所有权引用。
/// 通过在 `Weak` 指针上调用 [`upgrade`] 来访问分配,它返回一个 <code>[Option]<[Rc]\<T>></code>。
///
/// 由于 `Weak` 引用不计入所有权,因此它不会防止存储在分配中的值被丢弃,并且 `Weak` 本身不保证该值仍然存在。
///
/// 因此,当 [`upgrade`] 时,它可能返回 [`None`]。
/// 但是请注意,`Weak` 引用 *确实* 会阻止分配本身 (后备存储) 被释放。
///
/// `Weak` 指针可用于保持对 [`Rc`] 管理的分配的临时引用,而又不会阻止其内部值被丢弃。
/// 它也用于防止 [`Rc`] 指针之间的循环引用,因为相互拥有引用将永远不允许丢弃 [`Rc`]。
/// 例如,一棵树可以具有从父节点到子节点的强 [`Rc`] 指针,以及从子节点到其父节点的 `Weak` 指针。
///
/// 获取 `Weak` 指针的典型方法是调用 [`Rc::downgrade`]。
///
/// [`upgrade`]: Weak::upgrade
///
///
///
///
///
#[stable(feature = "rc_weak", since = "1.4.0")]
pub struct Weak<T: ?Sized> {
// 这是一个 `NonNull`,允许在枚举中优化此类型的大小,但它不一定是有效的指针。
//
// `Weak::new` 将它设置为 `usize::MAX`,这样它就不需要在堆上分配空间。
// 这不是一个真正的指针会有的值,因为 RcBox 至少有对齐 2.
// 仅当 `T: Sized` 时才有可能。未定义大小的 `T` 永远不会悬垂。
//
ptr: NonNull<RcBox<T>>,
}
#[stable(feature = "rc_weak", since = "1.4.0")]
impl<T: ?Sized> !Send for Weak<T> {}
#[stable(feature = "rc_weak", since = "1.4.0")]
impl<T: ?Sized> !Sync for Weak<T> {}
#[unstable(feature = "coerce_unsized", issue = "18598")]
impl<T: ?Sized + Unsize<U>, U: ?Sized> CoerceUnsized<Weak<U>> for Weak<T> {}
#[unstable(feature = "dispatch_from_dyn", issue = "none")]
impl<T: ?Sized + Unsize<U>, U: ?Sized> DispatchFromDyn<Weak<U>> for Weak<T> {}
impl<T> Weak<T> {
/// 创建一个新的 `Weak<T>`,而不分配任何内存。
/// 在返回值上调用 [`upgrade`] 总是得到 [`None`]。
///
/// [`upgrade`]: Weak::upgrade
///
/// # Examples
///
/// ```
/// use std::rc::Weak;
///
/// let empty: Weak<i64> = Weak::new();
/// assert!(empty.upgrade().is_none());
/// ```
#[stable(feature = "downgraded_weak", since = "1.10.0")]
#[rustc_const_unstable(feature = "const_weak_new", issue = "95091", reason = "recently added")]
#[must_use]
pub const fn new() -> Weak<T> {
Weak { ptr: unsafe { NonNull::new_unchecked(ptr::invalid_mut::<RcBox<T>>(usize::MAX)) } }
}
}
pub(crate) fn is_dangling<T: ?Sized>(ptr: *mut T) -> bool {
(ptr as *mut ()).addr() == usize::MAX
}
/// 帮助程序类型,允许访问引用计数而无需对数据字段进行任何声明。
///
struct WeakInner<'a> {
weak: &'a Cell<usize>,
strong: &'a Cell<usize>,
}
impl<T: ?Sized> Weak<T> {
/// 返回对此 `Weak<T>` 指向的对象 `T` 的裸指针。
///
/// 该指针仅在有一些强引用时才有效。
/// 指针可能是悬垂的,未对齐的,甚至是 [`null`]。
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
/// use std::ptr;
///
/// let strong = Rc::new("hello".to_owned());
/// let weak = Rc::downgrade(&strong);
/// // 两者都指向同一个对象
/// assert!(ptr::eq(&*strong, weak.as_ptr()));
/// // 这里的强项使它保持活动状态,因此我们仍然可以访问该对象。
/// assert_eq!("hello", unsafe { &*weak.as_ptr() });
///
/// drop(strong);
/// // 但是没有更多了。
/// // 我们可以执行 weak.as_ptr(),但是访问指针将导致未定义的行为。
/// // assert_eq!("hello", unsafe { &*weak.as_ptr() });
/// ```
///
/// [`null`]: ptr::null
#[must_use]
#[stable(feature = "rc_as_ptr", since = "1.45.0")]
pub fn as_ptr(&self) -> *const T {
let ptr: *mut RcBox<T> = NonNull::as_ptr(self.ptr);
if is_dangling(ptr) {
// 如果指针悬垂,我们将直接返回哨兵。
// 这不能是有效的有效载荷地址,因为有效载荷至少与 RcBox (usize) 对齐。
ptr as *const T
} else {
// SAFETY: 如果 is_dangling 返回 false,则该指针是可解引用的。
// 有效载荷可能会在此时被丢弃,所以我们必须维护出处,因此请使用裸指针操作。
//
unsafe { ptr::addr_of_mut!((*ptr).value) }
}
}
/// 消耗 `Weak<T>` 并将其转换为裸指针。
///
/// 这会将弱指针转换为裸指针,同时仍保留一个弱引用的所有权 (此操作不会修改弱引用计数)。
/// 可以将其转换回带有 [`from_raw`] 的 `Weak<T>`。
///
/// 与 [`as_ptr`] 一样,访问指针目标的限制也适用。
///
/// # Examples
///
/// ```
/// use std::rc::{Rc, Weak};
///
/// let strong = Rc::new("hello".to_owned());
/// let weak = Rc::downgrade(&strong);
/// let raw = weak.into_raw();
///
/// assert_eq!(1, Rc::weak_count(&strong));
/// assert_eq!("hello", unsafe { &*raw });
///
/// drop(unsafe { Weak::from_raw(raw) });
/// assert_eq!(0, Rc::weak_count(&strong));
/// ```
///
/// [`from_raw`]: Weak::from_raw
/// [`as_ptr`]: Weak::as_ptr
///
///
#[must_use = "`self` will be dropped if the result is not used"]
#[stable(feature = "weak_into_raw", since = "1.45.0")]
pub fn into_raw(self) -> *const T {
let result = self.as_ptr();
mem::forget(self);
result
}
/// 将先前由 [`into_raw`] 创建的裸指针转换回 `Weak<T>`。
///
/// 这可以用于安全地获得强引用 (稍后调用 [`upgrade`]) 或通过丢弃 `Weak<T>` 来分配弱引用计数。
///
/// 它拥有一个弱引用的所有权 (由 [`new`] 创建的指针除外,因为它们不拥有任何东西; 该方法仍适用于它们)。
///
/// # Safety
///
/// 指针必须起源于 [`into_raw`],并且仍然必须拥有其潜在的弱引用。
///
/// 调用时允许强引用计数为 0。
/// 不过,这需要当前表示为裸指针的弱引用的所有权 (该操作不会修改弱引用计数),因此必须与 [`into_raw`] 的先前调用配对。
///
///
/// # Examples
///
/// ```
/// use std::rc::{Rc, Weak};
///
/// let strong = Rc::new("hello".to_owned());
///
/// let raw_1 = Rc::downgrade(&strong).into_raw();
/// let raw_2 = Rc::downgrade(&strong).into_raw();
///
/// assert_eq!(2, Rc::weak_count(&strong));
///
/// assert_eq!("hello", &*unsafe { Weak::from_raw(raw_1) }.upgrade().unwrap());
/// assert_eq!(1, Rc::weak_count(&strong));
///
/// drop(strong);
///
/// // 减少最后一个弱引用计数。
/// assert!(unsafe { Weak::from_raw(raw_2) }.upgrade().is_none());
/// ```
///
/// [`into_raw`]: Weak::into_raw
/// [`upgrade`]: Weak::upgrade
/// [`new`]: Weak::new
///
///
///
///
#[stable(feature = "weak_into_raw", since = "1.45.0")]
pub unsafe fn from_raw(ptr: *const T) -> Self {
// 有关如何派生输入指针的上下文,请参见 Weak::as_ptr。
let ptr = if is_dangling(ptr as *mut T) {
// 这是悬垂的 Weak。
ptr as *mut RcBox<T>
} else {
// 否则,我们保证指针来自无悬挂的弱。
// SAFETY: data_offset 可以安全调用,因为 ptr 引用了一个真实的 (可能已丢弃) 的 T。
let offset = unsafe { data_offset(ptr) };
// 因此,我们反转偏移量以获得整个 RcBox。
// SAFETY: 指针源自 Weak,因此此偏移量是安全的。
unsafe { ptr.byte_sub(offset) as *mut RcBox<T> }
};
// SAFETY: 我们现在已经恢复了原始的弱指针,因此可以创建弱指针。
Weak { ptr: unsafe { NonNull::new_unchecked(ptr) } }
}
/// 尝试将 `Weak` 指针升级到 [`Rc`],如果成功,则延迟丢弃内部值。
///
///
/// 如果内部值已经被丢弃,则返回 [`None`]。
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let five = Rc::new(5);
///
/// let weak_five = Rc::downgrade(&five);
///
/// let strong_five: Option<Rc<_>> = weak_five.upgrade();
/// assert!(strong_five.is_some());
///
/// // 销毁所有强指针。
/// drop(strong_five);
/// drop(five);
///
/// assert!(weak_five.upgrade().is_none());
/// ```
#[must_use = "this returns a new `Rc`, \
without modifying the original weak pointer"]
#[stable(feature = "rc_weak", since = "1.4.0")]
pub fn upgrade(&self) -> Option<Rc<T>> {
let inner = self.inner()?;
if inner.strong() == 0 {
None
} else {
unsafe {
inner.inc_strong();
Some(Rc::from_inner(self.ptr))
}
}
}
/// 获取指向该分配的强 (`Rc`) 指针的数量。
///
/// 如果 `self` 是使用 [`Weak::new`] 创建的,这将返回 0.
#[must_use]
#[stable(feature = "weak_counts", since = "1.41.0")]
pub fn strong_count(&self) -> usize {
if let Some(inner) = self.inner() { inner.strong() } else { 0 }
}
/// 获取指向该分配的 `Weak` 指针的数量。
///
/// 如果没有剩余的强指针,它将返回零。
#[must_use]
#[stable(feature = "weak_counts", since = "1.41.0")]
pub fn weak_count(&self) -> usize {
self.inner()
.map(|inner| {
if inner.strong() > 0 {
inner.weak() - 1 // 减去隐含的弱指针
} else {
0
}
})
.unwrap_or(0)
}
/// 当指针悬垂并且没有分配的 `RcBox` 时 (即,当 `Weak` 由 `Weak::new` 创建时),返回 `None`。
///
#[inline]
fn inner(&self) -> Option<WeakInner<'_>> {
if is_dangling(self.ptr.as_ptr()) {
None
} else {
// 我们小心 *不要* 创建覆盖 "data" 字段的引用,因为该字段可能会同时被修改 (例如,如果最后一个 `Rc` 被丢弃,则数据字段将被原地丢弃)。
//
//
Some(unsafe {
let ptr = self.ptr.as_ptr();
WeakInner { strong: &(*ptr).strong, weak: &(*ptr).weak }
})
}
}
/// 如果两个 `Weak` 指向与 [`ptr::eq`] 类似的相同分配,或者两者都不指向任何分配 (因为它们是使用 `Weak::new()` 创建的),则返回 `true`。
/// 比较 `dyn Trait` 指针时的注意事项,请参见 [that function][`ptr::eq`]。
///
/// # Notes
///
/// 由于这将比较指针,这意味着 `Weak::new()` 将彼此相等,即使它们不指向任何分配。
///
/// # Examples
///
/// ```
/// use std::rc::Rc;
///
/// let first_rc = Rc::new(5);
/// let first = Rc::downgrade(&first_rc);
/// let second = Rc::downgrade(&first_rc);
///
/// assert!(first.ptr_eq(&second));
///
/// let third_rc = Rc::new(5);
/// let third = Rc::downgrade(&third_rc);
///
/// assert!(!first.ptr_eq(&third));
/// ```
///
/// 比较 `Weak::new`。
///
/// ```
/// use std::rc::{Rc, Weak};
///
/// let first = Weak::new();
/// let second = Weak::new();
/// assert!(first.ptr_eq(&second));
///
/// let third_rc = Rc::new(());
/// let third = Rc::downgrade(&third_rc);
/// assert!(!first.ptr_eq(&third));
/// ```
///
///
#[inline]
#[must_use]
#[stable(feature = "weak_ptr_eq", since = "1.39.0")]
pub fn ptr_eq(&self, other: &Self) -> bool {
self.ptr.as_ptr() == other.ptr.as_ptr()
}
}
#[stable(feature = "rc_weak", since = "1.4.0")]
unsafe impl<#[may_dangle] T: ?Sized> Drop for Weak<T> {
/// 丢弃 `Weak` 指针。
///
/// # Examples
///
/// ```
/// use std::rc::{Rc, Weak};
///
/// struct Foo;
///
/// impl Drop for Foo {
/// fn drop(&mut self) {
/// println!("dropped!");
/// }
/// }
///
/// let foo = Rc::new(Foo);
/// let weak_foo = Rc::downgrade(&foo);
/// let other_weak_foo = Weak::clone(&weak_foo);
///
/// drop(weak_foo); // 不打印任何东西
/// drop(foo); // 打印 "dropped!"
///
/// assert!(other_weak_foo.upgrade().is_none());
/// ```
fn drop(&mut self) {
let inner = if let Some(inner) = self.inner() { inner } else { return };
inner.dec_weak();
// 弱引用计数从 1 开始,并且仅在所有强指针都消失后才变为零。
//
if inner.weak() == 0 {
unsafe {
Global.deallocate(self.ptr.cast(), Layout::for_value_raw(self.ptr.as_ptr()));
}
}
}
}
#[stable(feature = "rc_weak", since = "1.4.0")]
impl<T: ?Sized> Clone for Weak<T> {
/// 克隆 `Weak` 指针,该指针指向相同的分配。
///
/// # Examples
///
/// ```
/// use std::rc::{Rc, Weak};
///
/// let weak_five = Rc::downgrade(&Rc::new(5));
///
/// let _ = Weak::clone(&weak_five);
/// ```
#[inline]
fn clone(&self) -> Weak<T> {
if let Some(inner) = self.inner() {
inner.inc_weak()
}
Weak { ptr: self.ptr }
}
}
#[stable(feature = "rc_weak", since = "1.4.0")]
impl<T: ?Sized> fmt::Debug for Weak<T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, "(Weak)")
}
}
#[stable(feature = "downgraded_weak", since = "1.10.0")]
impl<T> Default for Weak<T> {
/// 创建一个新的 `Weak<T>`,而不分配任何内存。
/// 在返回值上调用 [`upgrade`] 总是得到 [`None`]。
///
/// [`upgrade`]: Weak::upgrade
///
/// # Examples
///
/// ```
/// use std::rc::Weak;
///
/// let empty: Weak<i64> = Default::default();
/// assert!(empty.upgrade().is_none());
/// ```
fn default() -> Weak<T> {
Weak::new()
}
}
// NOTE: 我们在这里 check_add 来安全地处理 mem::forget。
// 特别是如果您使用 mem::forget Rcs (或 Weaks),则引用计数可能会溢出,然后您可以在存在出色的 Rcs (或 Weaks) 的情况下释放分配。
//
// 我们中止是因为这是一个如此退化的场景,以至于我们不关心会发生什么 - 任何真正的程序都不应该经历这种情况。
//
// 这应该具有可忽略的开销,因为由于所有权和移动语义,您实际上不需要在 Rust 中克隆太多代码。
//
//
#[doc(hidden)]
trait RcInnerPtr {
fn weak_ref(&self) -> &Cell<usize>;
fn strong_ref(&self) -> &Cell<usize>;
#[inline]
fn strong(&self) -> usize {
self.strong_ref().get()
}
#[inline]
fn inc_strong(&self) {
let strong = self.strong();
// 我们在这里插入一个 `assume`,以提示 LLVM 否则会错过优化。
//
// SAFETY: 调用此函数时,引用计数永远不会为零。
//
unsafe {
core::intrinsics::assume(strong != 0);
}
let strong = strong.wrapping_add(1);
self.strong_ref().set(strong);
// 我们希望在溢出时中止,而不是丢弃值。
// 在存储之后而不是之前检查溢出允许更好的代码生成。
//
if core::intrinsics::unlikely(strong == 0) {
abort();
}
}
#[inline]
fn dec_strong(&self) {
self.strong_ref().set(self.strong() - 1);
}
#[inline]
fn weak(&self) -> usize {
self.weak_ref().get()
}
#[inline]
fn inc_weak(&self) {
let weak = self.weak();
// 我们在这里插入一个 `assume`,以提示 LLVM 否则会错过优化。
//
// SAFETY: 调用此函数时,引用计数永远不会为零。
//
unsafe {
core::intrinsics::assume(weak != 0);
}
let weak = weak.wrapping_add(1);
self.weak_ref().set(weak);
// 我们希望在溢出时中止,而不是丢弃值。
// 在存储之后而不是之前检查溢出允许更好的代码生成。
//
if core::intrinsics::unlikely(weak == 0) {
abort();
}
}
#[inline]
fn dec_weak(&self) {
self.weak_ref().set(self.weak() - 1);
}
}
impl<T: ?Sized> RcInnerPtr for RcBox<T> {
#[inline(always)]
fn weak_ref(&self) -> &Cell<usize> {
&self.weak
}
#[inline(always)]
fn strong_ref(&self) -> &Cell<usize> {
&self.strong
}
}
impl<'a> RcInnerPtr for WeakInner<'a> {
#[inline(always)]
fn weak_ref(&self) -> &Cell<usize> {
self.weak
}
#[inline(always)]
fn strong_ref(&self) -> &Cell<usize> {
self.strong
}
}
#[stable(feature = "rust1", since = "1.0.0")]
impl<T: ?Sized> borrow::Borrow<T> for Rc<T> {
fn borrow(&self) -> &T {
&**self
}
}
#[stable(since = "1.5.0", feature = "smart_ptr_as_ref")]
impl<T: ?Sized> AsRef<T> for Rc<T> {
fn as_ref(&self) -> &T {
&**self
}
}
#[stable(feature = "pin", since = "1.33.0")]
impl<T: ?Sized> Unpin for Rc<T> {}
/// 为指针后面的有效载荷获取 `RcBox` 内的偏移量。
///
/// # Safety
///
/// 指针必须指向 T 的先前有效实例 (并具有有效的元数据),但是允许丢弃 T。
///
unsafe fn data_offset<T: ?Sized>(ptr: *const T) -> usize {
// 将未定义大小的值与 RcBox 的末端对齐。
// 由于 RcBox 是 repr(C),因此它将始终是内存中的最后一个字段。
// SAFETY: 由于唯一可能的未定义大小类型是切片,trait 对象和外部类型,因此当前输入的安全要求足以满足 align_of_val_raw 的要求; 这是 std 之外不得依赖的语言的实现细节。
//
//
//
unsafe { data_offset_align(align_of_val_raw(ptr)) }
}
#[inline]
fn data_offset_align(align: usize) -> usize {
let layout = Layout::new::<RcBox<()>>();
layout.size() + layout.padding_needed_for(align)
}