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 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021
use crate::array;
use crate::cmp::{self, Ordering};
use crate::num::NonZeroUsize;
use crate::ops::{ChangeOutputType, ControlFlow, FromResidual, Residual, Try};
use super::super::try_process;
use super::super::ByRefSized;
use super::super::TrustedRandomAccessNoCoerce;
use super::super::{ArrayChunks, Chain, Cloned, Copied, Cycle, Enumerate, Filter, FilterMap, Fuse};
use super::super::{FlatMap, Flatten};
use super::super::{FromIterator, Intersperse, IntersperseWith, Product, Sum, Zip};
use super::super::{
Inspect, Map, MapWhile, Peekable, Rev, Scan, Skip, SkipWhile, StepBy, Take, TakeWhile,
};
fn _assert_is_object_safe(_: &dyn Iterator<Item = ()>) {}
/// 用于处理迭代器的 trait。
///
/// 这是主要的迭代器 trait。
/// 有关一般迭代器概念的更多信息,请参见 [模块级文档][module-level documentation]。
/// 特别是,您可能想知道如何 [实现 `Iterator`][impl]。
///
/// [module-level documentation]: crate::iter
/// [impl]: crate::iter#implementing-iterator
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_on_unimplemented(
on(
_Self = "std::ops::RangeTo<Idx>",
label = "if you meant to iterate until a value, add a starting value",
note = "`..end` is a `RangeTo`, which cannot be iterated on; you might have meant to have a \
bounded `Range`: `0..end`"
),
on(
_Self = "std::ops::RangeToInclusive<Idx>",
label = "if you meant to iterate until a value (including it), add a starting value",
note = "`..=end` is a `RangeToInclusive`, which cannot be iterated on; you might have meant \
to have a bounded `RangeInclusive`: `0..=end`"
),
on(
_Self = "[]",
label = "`{Self}` is not an iterator; try calling `.into_iter()` or `.iter()`"
),
on(_Self = "&[]", label = "`{Self}` is not an iterator; try calling `.iter()`"),
on(
_Self = "std::vec::Vec<T, A>",
label = "`{Self}` is not an iterator; try calling `.into_iter()` or `.iter()`"
),
on(
_Self = "&str",
label = "`{Self}` is not an iterator; try calling `.chars()` or `.bytes()`"
),
on(
_Self = "std::string::String",
label = "`{Self}` is not an iterator; try calling `.chars()` or `.bytes()`"
),
on(
_Self = "{integral}",
note = "if you want to iterate between `start` until a value `end`, use the exclusive range \
syntax `start..end` or the inclusive range syntax `start..=end`"
),
on(
_Self = "{float}",
note = "if you want to iterate between `start` until a value `end`, use the exclusive range \
syntax `start..end` or the inclusive range syntax `start..=end`"
),
label = "`{Self}` is not an iterator",
message = "`{Self}` is not an iterator"
)]
#[doc(notable_trait)]
#[rustc_diagnostic_item = "Iterator"]
#[must_use = "iterators are lazy and do nothing unless consumed"]
pub trait Iterator {
/// 被迭代的元素的类型。
#[rustc_diagnostic_item = "IteratorItem"]
#[stable(feature = "rust1", since = "1.0.0")]
type Item;
/// 推进迭代器并返回下一个值。
///
/// 迭代完成后返回 [`None`]。
/// 各个迭代器的实现可能选择恢复迭代,因此再次调用 `next()` 可能会或可能不会最终在某个时候开始再次返回 [`Some(Item)`]。
///
///
/// [`Some(Item)`]: Some
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
///
/// let mut iter = a.iter();
///
/// // 调用 next() 返回下一个值...
/// assert_eq!(Some(&1), iter.next());
/// assert_eq!(Some(&2), iter.next());
/// assert_eq!(Some(&3), iter.next());
///
/// // ... 然后,一旦结束,就再也没有。
/// assert_eq!(None, iter.next());
///
/// // 更多调用可能会也可能不会返回 `None`。在这里,他们总是会的。
/// assert_eq!(None, iter.next());
/// assert_eq!(None, iter.next());
/// ```
///
#[lang = "next"]
#[stable(feature = "rust1", since = "1.0.0")]
fn next(&mut self) -> Option<Self::Item>;
/// 推进迭代器并返回包含下一个 `N` 值的数组。
///
/// 如果没有足够的元素来填充数组,则返回 `Err`,其中包含剩余元素的迭代器。
///
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// #![feature(iter_next_chunk)]
///
/// let mut iter = "lorem".chars();
///
/// assert_eq!(iter.next_chunk().unwrap(), ['l', 'o']); // N 被推断为 2
/// assert_eq!(iter.next_chunk().unwrap(), ['r', 'e', 'm']); // N 被推断为 3
/// assert_eq!(iter.next_chunk::<4>().unwrap_err().as_slice(), &[]); // N 显式为 4
/// ```
///
/// 拆分一个字符串并获取前三个项。
///
/// ```
/// #![feature(iter_next_chunk)]
///
/// let quote = "not all those who wander are lost";
/// let [first, second, third] = quote.split_whitespace().next_chunk().unwrap();
/// assert_eq!(first, "not");
/// assert_eq!(second, "all");
/// assert_eq!(third, "those");
/// ```
#[inline]
#[unstable(feature = "iter_next_chunk", reason = "recently added", issue = "98326")]
#[rustc_do_not_const_check]
fn next_chunk<const N: usize>(
&mut self,
) -> Result<[Self::Item; N], array::IntoIter<Self::Item, N>>
where
Self: Sized,
{
array::iter_next_chunk(self)
}
/// 返回迭代器剩余长度的界限。
///
/// 具体来说,`size_hint()` 返回一个元组,其中第一个元素是下界,第二个元素是上界。
///
/// 返回的元组的后半部分是 <code>[Option]<[usize]></code>。
/// 这里的 [`None`] 表示没有已知的上限,或者该上限大于 [`usize`]。
///
/// # 实现说明
///
/// 没有强制要求迭代器实现产生声明数量的元素。buggy 迭代器的结果可能小于元素的下限,也可能大于元素的上限。
///
/// `size_hint()` 主要用于优化,例如为迭代器的元素保留空间,但不能被信任,例如省略不安全代码中的边界检查。
/// `size_hint()` 的不正确实现不应导致违反内存安全性。
///
/// 也就是说,该实现应提供正确的估计,因为否则将违反 trait 的协议。
///
/// 默认实现返回 <code>(0, [None])</code> 这对于任何迭代器都是正确的。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
/// let mut iter = a.iter();
///
/// assert_eq!((3, Some(3)), iter.size_hint());
/// let _ = iter.next();
/// assert_eq!((2, Some(2)), iter.size_hint());
/// ```
///
/// 一个更复杂的示例:
///
/// ```
/// // 介于 0 到 9 之间的偶数。
/// let iter = (0..10).filter(|x| x % 2 == 0);
///
/// // 我们可以从零迭代到十次。
/// // 不执行 filter() 就不可能知道它是 5。
/// assert_eq!((0, Some(10)), iter.size_hint());
///
/// // 让我们用 chain() 再添加五个数字
/// let iter = (0..10).filter(|x| x % 2 == 0).chain(15..20);
///
/// // 现在两个界限都增加了五个
/// assert_eq!((5, Some(15)), iter.size_hint());
/// ```
///
/// 返回 `None` 作为上限:
///
/// ```
/// // 无限迭代器没有上限,最大可能下限
/////
/// let iter = 0..;
///
/// assert_eq!((usize::MAX, None), iter.size_hint());
/// ```
///
///
///
///
///
///
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn size_hint(&self) -> (usize, Option<usize>) {
(0, None)
}
/// 消耗迭代器,计算迭代次数并返回它。
///
/// 此方法将反复调用 [`next`],直到遇到 [`None`],并返回它看到 [`Some`] 的次数。
/// 请注意,即使迭代器没有任何元素,也必须至少调用一次 [`next`]。
///
/// [`next`]: Iterator::next
///
/// # 溢出行为
///
/// 该方法无法防止溢出,因此对具有超过 [`usize::MAX`] 个元素的迭代器的元素进行计数会产生错误的结果或 panics。
///
/// 如果启用了调试断言,则将保证 panic。
///
/// # Panics
///
/// 如果迭代器具有多个 [`usize::MAX`] 元素,则此函数可能为 panic。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
/// assert_eq!(a.iter().count(), 3);
///
/// let a = [1, 2, 3, 4, 5];
/// assert_eq!(a.iter().count(), 5);
/// ```
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn count(self) -> usize
where
Self: Sized,
{
self.fold(
0,
#[rustc_inherit_overflow_checks]
|count, _| count + 1,
)
}
/// 消耗迭代器,返回最后一个元素。
///
/// 此方法将评估迭代器,直到返回 [`None`]。
/// 这样做时,它会跟踪当前元素。
/// 返回 [`None`] 之后,`last()` 将返回它看到的最后一个元素。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
/// assert_eq!(a.iter().last(), Some(&3));
///
/// let a = [1, 2, 3, 4, 5];
/// assert_eq!(a.iter().last(), Some(&5));
/// ```
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn last(self) -> Option<Self::Item>
where
Self: Sized,
{
#[inline]
fn some<T>(_: Option<T>, x: T) -> Option<T> {
Some(x)
}
self.fold(None, some)
}
/// 通过 `n` 元素使迭代器前进。
///
/// 该方法将通过最多 `n` 次调用 [`next`] 来急切地跳过 `n` 元素,直到遇到 [`None`]。
///
/// 如果迭代器成功前进了 `n` 个元素,`advance_by(n)` 将返回 `Ok(())`,如果遇到 [`None`],则返回值为 `k` 的 `Err(NonZeroUsize)`,其中 `k` 是由于迭代器用完而无法前进的剩余步数。
///
/// 如果 `self` 为空且 `n` 非零,则返回 `Err(n)`。
/// 否则,`k` 总是小于 `n`。
///
/// 调用 `advance_by(0)` 可以做有意义的工作,例如 [`Flatten`] 可以推进它的外部迭代器,直到它找到一个不为空的内部迭代器,然后通常允许它返回一个比初始状态更准确的 `size_hint()`。
///
/// [`Flatten`]: crate::iter::Flatten
/// [`next`]: Iterator::next
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// #![feature(iter_advance_by)]
///
/// use std::num::NonZeroUsize;
/// let a = [1, 2, 3, 4];
/// let mut iter = a.iter();
///
/// assert_eq!(iter.advance_by(2), Ok(()));
/// assert_eq!(iter.next(), Some(&3));
/// assert_eq!(iter.advance_by(0), Ok(()));
/// assert_eq!(iter.advance_by(100), Err(NonZeroUsize::new(99).unwrap())); // 仅跳过 `&4`
/// ```
///
///
///
///
#[inline]
#[unstable(feature = "iter_advance_by", reason = "recently added", issue = "77404")]
#[rustc_do_not_const_check]
fn advance_by(&mut self, n: usize) -> Result<(), NonZeroUsize> {
for i in 0..n {
if self.next().is_none() {
// SAFETY: `i` 总是小于 `n`。
return Err(unsafe { NonZeroUsize::new_unchecked(n - i) });
}
}
Ok(())
}
/// 返回迭代器的第 n 个元素。
///
/// 像大多数索引操作一样,计数从零开始,因此 `nth(0)` 返回第一个值,`nth(1)` 返回第二个值,依此类推。
///
/// 请注意,所有先前的元素以及返回的元素都将从迭代器中消耗。
/// 这意味着前面的元素将被丢弃,并且在同一迭代器上多次调用 `nth(0)` 将返回不同的元素。
///
///
/// 如果 `n` 大于或等于迭代器的长度,则 `nth()` 将返回 [`None`]。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
/// assert_eq!(a.iter().nth(1), Some(&2));
/// ```
///
/// 多次调用 `nth()` 不会回退迭代器:
///
/// ```
/// let a = [1, 2, 3];
///
/// let mut iter = a.iter();
///
/// assert_eq!(iter.nth(1), Some(&2));
/// assert_eq!(iter.nth(1), None);
/// ```
///
/// 如果少于 `n + 1` 个元素,则返回 `None`:
///
/// ```
/// let a = [1, 2, 3];
/// assert_eq!(a.iter().nth(10), None);
/// ```
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn nth(&mut self, n: usize) -> Option<Self::Item> {
self.advance_by(n).ok()?;
self.next()
}
/// 创建一个从同一点开始的迭代器,但在每次迭代时以给定的数量逐步执行。
///
/// Note 1: 无论给出的步骤如何,总是会返回迭代器的第一个元素。
///
/// Note 2: 被忽略的元素被拉出的时间不是固定的。
/// `StepBy` 的行为类似于序列 `self.next()`, `self.nth(step-1)`, `self.nth(step-1)`,…,但也可以自由地表现成序列 `advance_n_and_return_first(&mut self, step)`, `advance_n_and_return_first(&mut self, step)`,…出于性能原因,对于某些迭代器,使用哪种方式可能会发生变化。
///
/// 第二种方法将使迭代器更早地进行,并可能消耗更多的项。
///
/// `advance_n_and_return_first` 相当于:
///
/// ```
/// fn advance_n_and_return_first<I>(iter: &mut I, n: usize) -> Option<I::Item>
/// where
/// I: Iterator,
/// {
/// let next = iter.next();
/// if n > 1 {
/// iter.nth(n - 2);
/// }
/// next
/// }
/// ```
///
/// # Panics
///
/// 如果给定步骤为 `0`,则该方法将为 panic。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [0, 1, 2, 3, 4, 5];
/// let mut iter = a.iter().step_by(2);
///
/// assert_eq!(iter.next(), Some(&0));
/// assert_eq!(iter.next(), Some(&2));
/// assert_eq!(iter.next(), Some(&4));
/// assert_eq!(iter.next(), None);
/// ```
///
///
///
///
#[inline]
#[stable(feature = "iterator_step_by", since = "1.28.0")]
#[rustc_do_not_const_check]
fn step_by(self, step: usize) -> StepBy<Self>
where
Self: Sized,
{
StepBy::new(self, step)
}
/// 接受两个迭代器,并依次在两个迭代器上创建一个新的迭代器。
///
/// `chain()` 将返回一个新的迭代器,它首先迭代第一个迭代器的值,然后迭代第二个迭代器的值。
///
/// 换句话说,它将两个迭代器链接在一起。🔗
///
/// [`once`] 通常用于将单个值调整为其他类型的迭代链。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a1 = [1, 2, 3];
/// let a2 = [4, 5, 6];
///
/// let mut iter = a1.iter().chain(a2.iter());
///
/// assert_eq!(iter.next(), Some(&1));
/// assert_eq!(iter.next(), Some(&2));
/// assert_eq!(iter.next(), Some(&3));
/// assert_eq!(iter.next(), Some(&4));
/// assert_eq!(iter.next(), Some(&5));
/// assert_eq!(iter.next(), Some(&6));
/// assert_eq!(iter.next(), None);
/// ```
///
/// 由于 `chain()` 的参数使用 [`IntoIterator`],因此我们可以传递可以转换为 [`Iterator`] 的所有内容,而不仅仅是 [`Iterator`] 本身。
/// 例如,切片 (`&[T]`) 实现 [`IntoIterator`],因此可以直接传递给 `chain()`:
///
/// ```
/// let s1 = &[1, 2, 3];
/// let s2 = &[4, 5, 6];
///
/// let mut iter = s1.iter().chain(s2);
///
/// assert_eq!(iter.next(), Some(&1));
/// assert_eq!(iter.next(), Some(&2));
/// assert_eq!(iter.next(), Some(&3));
/// assert_eq!(iter.next(), Some(&4));
/// assert_eq!(iter.next(), Some(&5));
/// assert_eq!(iter.next(), Some(&6));
/// assert_eq!(iter.next(), None);
/// ```
///
/// 如果使用 Windows API,则可能希望将 [`OsStr`] 转换为 `Vec<u16>`:
///
/// ```
/// #[cfg(windows)]
/// fn os_str_to_utf16(s: &std::ffi::OsStr) -> Vec<u16> {
/// use std::os::windows::ffi::OsStrExt;
/// s.encode_wide().chain(std::iter::once(0)).collect()
/// }
/// ```
///
/// [`once`]: crate::iter::once
/// [`OsStr`]: ../../std/ffi/struct.OsStr.html
///
///
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn chain<U>(self, other: U) -> Chain<Self, U::IntoIter>
where
Self: Sized,
U: IntoIterator<Item = Self::Item>,
{
Chain::new(self, other.into_iter())
}
/// 将两个迭代器压缩为成对的单个迭代器。
///
/// `zip()` 返回一个新的迭代器,它将迭代其他两个迭代器,返回一个元组,其中第一个元素来自第一个迭代器,第二个元素来自第二个迭代器。
///
/// 换句话说,它将两个迭代器压缩在一起,形成一个单一的迭代器。
///
/// 如果任一迭代器返回 [`None`],则 zipped 迭代器中的 [`next`] 将返回 [`None`]。
/// 如果 zipped 迭代器没有更多的元素要返回,那么每次进一步尝试推进它时,将首先尝试最多推进第一个迭代器一次,如果它仍然生成一个项,则尝试最多推进第二个迭代器一次。
///
///
/// 压缩两个迭代器的结果到 'undo',请参见 [`unzip`]。
///
/// [`unzip`]: Iterator::unzip
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a1 = [1, 2, 3];
/// let a2 = [4, 5, 6];
///
/// let mut iter = a1.iter().zip(a2.iter());
///
/// assert_eq!(iter.next(), Some((&1, &4)));
/// assert_eq!(iter.next(), Some((&2, &5)));
/// assert_eq!(iter.next(), Some((&3, &6)));
/// assert_eq!(iter.next(), None);
/// ```
///
/// 由于 `zip()` 的参数使用 [`IntoIterator`],因此我们可以传递可以转换为 [`Iterator`] 的所有内容,而不仅仅是 [`Iterator`] 本身。
/// 例如,切片 (`&[T]`) 实现 [`IntoIterator`],因此可以直接传递给 `zip()`:
///
/// ```
/// let s1 = &[1, 2, 3];
/// let s2 = &[4, 5, 6];
///
/// let mut iter = s1.iter().zip(s2);
///
/// assert_eq!(iter.next(), Some((&1, &4)));
/// assert_eq!(iter.next(), Some((&2, &5)));
/// assert_eq!(iter.next(), Some((&3, &6)));
/// assert_eq!(iter.next(), None);
/// ```
///
/// `zip()` 通常用于将无限迭代器压缩为有限迭代器。
/// 这是可行的,因为有限迭代器最终将返回 [`None`],从而结束拉链。使用 `(0..)` 压缩看起来很像 [`enumerate`]:
///
/// ```
/// let enumerate: Vec<_> = "foo".chars().enumerate().collect();
///
/// let zipper: Vec<_> = (0..).zip("foo".chars()).collect();
///
/// assert_eq!((0, 'f'), enumerate[0]);
/// assert_eq!((0, 'f'), zipper[0]);
///
/// assert_eq!((1, 'o'), enumerate[1]);
/// assert_eq!((1, 'o'), zipper[1]);
///
/// assert_eq!((2, 'o'), enumerate[2]);
/// assert_eq!((2, 'o'), zipper[2]);
/// ```
///
/// 如果两个迭代器的语法大致相同,则使用 [`zip`] 可能更具可读性:
///
/// ```
/// use std::iter::zip;
///
/// let a = [1, 2, 3];
/// let b = [2, 3, 4];
///
/// let mut zipped = zip(
/// a.into_iter().map(|x| x * 2).skip(1),
/// b.into_iter().map(|x| x * 2).skip(1),
/// );
///
/// assert_eq!(zipped.next(), Some((4, 6)));
/// assert_eq!(zipped.next(), Some((6, 8)));
/// assert_eq!(zipped.next(), None);
/// ```
///
/// 相比之下:
///
/// ```
/// # let a = [1, 2, 3];
/// # let b = [2, 3, 4];
/// #
/// let mut zipped = a
/// .into_iter()
/// .map(|x| x * 2)
/// .skip(1)
/// .zip(b.into_iter().map(|x| x * 2).skip(1));
/// #
/// # assert_eq!(zipped.next(), Some((4, 6)));
/// # assert_eq!(zipped.next(), Some((6, 8)));
/// # assert_eq!(zipped.next(), None);
/// ```
///
/// [`enumerate`]: Iterator::enumerate
/// [`next`]: Iterator::next
/// [`zip`]: crate::iter::zip
///
///
///
///
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn zip<U>(self, other: U) -> Zip<Self, U::IntoIter>
where
Self: Sized,
U: IntoIterator,
{
Zip::new(self, other.into_iter())
}
/// 创建一个新的迭代器,该迭代器将 `separator` 的副本放置在原始迭代器的相邻项之间。
///
/// 如果 `separator` 未实现 [`Clone`] 或每次都需要计算,请使用 [`intersperse_with`]。
///
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// #![feature(iter_intersperse)]
///
/// let mut a = [0, 1, 2].iter().intersperse(&100);
/// assert_eq!(a.next(), Some(&0)); // `a` 中的第一个元素。
/// assert_eq!(a.next(), Some(&100)); // 分隔符。
/// assert_eq!(a.next(), Some(&1)); // `a` 中的下一个元素。
/// assert_eq!(a.next(), Some(&100)); // 分隔符。
/// assert_eq!(a.next(), Some(&2)); // `a` 中的最后一个元素。
/// assert_eq!(a.next(), None); // 迭代器完成。
/// ```
///
/// `intersperse` 对于使用公共元素连接迭代器的项非常有用:
///
/// ```
/// #![feature(iter_intersperse)]
///
/// let hello = ["Hello", "World", "!"].iter().copied().intersperse(" ").collect::<String>();
/// assert_eq!(hello, "Hello World !");
/// ```
///
/// [`Clone`]: crate::clone::Clone
/// [`intersperse_with`]: Iterator::intersperse_with
#[inline]
#[unstable(feature = "iter_intersperse", reason = "recently added", issue = "79524")]
#[rustc_do_not_const_check]
fn intersperse(self, separator: Self::Item) -> Intersperse<Self>
where
Self: Sized,
Self::Item: Clone,
{
Intersperse::new(self, separator)
}
/// 创建一个新的迭代器,该迭代器将 `separator` 生成的项放在原始迭代器的相邻项之间。
///
/// 每次将一个项放置在底层迭代器的两个相邻项之间时,闭包将被精确地调用一次;
/// 具体来说,如果底层迭代器的产量少于两个项目,并且在产生最后一个项目之后,则不调用闭包。
///
///
/// 如果迭代器的项实现 [`Clone`],则使用 [`intersperse`] 可能会更容易。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// #![feature(iter_intersperse)]
///
/// #[derive(PartialEq, Debug)]
/// struct NotClone(usize);
///
/// let v = [NotClone(0), NotClone(1), NotClone(2)];
/// let mut it = v.into_iter().intersperse_with(|| NotClone(99));
///
/// assert_eq!(it.next(), Some(NotClone(0))); // `v` 中的第一个元素。
/// assert_eq!(it.next(), Some(NotClone(99))); // 分隔符。
/// assert_eq!(it.next(), Some(NotClone(1))); // `v` 中的下一个元素。
/// assert_eq!(it.next(), Some(NotClone(99))); // 分隔符。
/// assert_eq!(it.next(), Some(NotClone(2))); // `v` 的最后一个元素。
/// assert_eq!(it.next(), None); // 迭代器完成。
/// ```
///
/// `intersperse_with` 可用于需要计算分隔符的情况:
///
/// ```
/// #![feature(iter_intersperse)]
///
/// let src = ["Hello", "to", "all", "people", "!!"].iter().copied();
///
/// // 闭包可变地借用其上下文以生成项。
/// let mut happy_emojis = [" ❤️ ", " 😀 "].iter().copied();
/// let separator = || happy_emojis.next().unwrap_or(" 🦀 ");
///
/// let result = src.intersperse_with(separator).collect::<String>();
/// assert_eq!(result, "Hello ❤️ to 😀 all 🦀 people 🦀 !!");
/// ```
///
/// [`Clone`]: crate::clone::Clone
/// [`intersperse`]: Iterator::intersperse
///
///
#[inline]
#[unstable(feature = "iter_intersperse", reason = "recently added", issue = "79524")]
#[rustc_do_not_const_check]
fn intersperse_with<G>(self, separator: G) -> IntersperseWith<Self, G>
where
Self: Sized,
G: FnMut() -> Self::Item,
{
IntersperseWith::new(self, separator)
}
/// 获取一个闭包并创建一个迭代器,该迭代器在每个元素上调用该闭包。
///
/// `map()` 通过其参数将一个迭代器转换为另一个迭代器:
/// 实现 [`FnMut`] 的东西。它产生一个新的迭代器,在原始迭代器的每个元素上调用此闭包。
///
/// 如果您善于思考类型,则可以这样考虑 `map()`:
/// 如果您有一个迭代器为您提供某种类型的 `A` 元素,并且您想要某种其他类型的 `B` 的迭代器,则可以使用 `map()`,传递一个需要 `A` 并返回 `B` 的闭包。
///
///
/// `map()` 在概念上类似于 [`for`] 循环。但是,由于 `map()` 是惰性的,因此当您已经在使用其他迭代器时,最好使用 `map()`。
/// 如果您要进行某种循环的副作用,则认为使用 [`for`] 比使用 `map()` 更惯用。
///
/// [`for`]: ../../book/ch03-05-control-flow.html#looping-through-a-collection-with-for
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
///
/// let mut iter = a.iter().map(|x| 2 * x);
///
/// assert_eq!(iter.next(), Some(2));
/// assert_eq!(iter.next(), Some(4));
/// assert_eq!(iter.next(), Some(6));
/// assert_eq!(iter.next(), None);
/// ```
///
/// 如果您正在做某种副作用,请首选 [`for`] 而不是 `map()`:
///
/// ```
/// # #![allow(unused_must_use)]
/// // 不要这样做:
/// (0..5).map(|x| println!("{x}"));
///
/// // 它甚至不会执行,因为它很懒。Rust 会就此警告您。
///
/// // 而是用于:
/// for x in 0..5 {
/// println!("{x}");
/// }
/// ```
///
///
///
///
///
#[rustc_diagnostic_item = "IteratorMap"]
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn map<B, F>(self, f: F) -> Map<Self, F>
where
Self: Sized,
F: FnMut(Self::Item) -> B,
{
Map::new(self, f)
}
/// 在迭代器的每个元素上调用一个闭包。
///
/// 这等效于在迭代器上使用 [`for`] 循环,尽管不能从封闭包中获得 `break` 和 `continue`。
/// 通常,使用 `for` 循环更为习惯,但是在较长的迭代器链的末尾处理 Item 时,`for_each` 可能更容易理解。
///
/// 在某些情况下,`for_each` 也可能比循环更快,因为它将在 `Chain` 等适配器上使用内部迭代。
///
/// [`for`]: ../../book/ch03-05-control-flow.html#looping-through-a-collection-with-for
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// use std::sync::mpsc::channel;
///
/// let (tx, rx) = channel();
/// (0..5).map(|x| x * 2 + 1)
/// .for_each(move |x| tx.send(x).unwrap());
///
/// let v: Vec<_> = rx.iter().collect();
/// assert_eq!(v, vec![1, 3, 5, 7, 9]);
/// ```
///
/// 对于这么小的示例,`for` 循环可能更干净,但是 `for_each` 可能更适合于保留具有较长迭代器的功能样式:
///
/// ```
/// (0..5).flat_map(|x| x * 100 .. x * 110)
/// .enumerate()
/// .filter(|&(i, x)| (i + x) % 3 == 0)
/// .for_each(|(i, x)| println!("{i}:{x}"));
/// ```
///
///
///
#[inline]
#[stable(feature = "iterator_for_each", since = "1.21.0")]
#[rustc_do_not_const_check]
fn for_each<F>(self, f: F)
where
Self: Sized,
F: FnMut(Self::Item),
{
#[inline]
fn call<T>(mut f: impl FnMut(T)) -> impl FnMut((), T) {
move |(), item| f(item)
}
self.fold((), call(f));
}
/// 创建一个迭代器,该迭代器使用闭包确定是否应产生元素。
///
/// 给定一个元素,闭包必须返回 `true` 或 `false`。返回的迭代器将仅生成闭包为其返回 true 的元素。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [0i32, 1, 2];
///
/// let mut iter = a.iter().filter(|x| x.is_positive());
///
/// assert_eq!(iter.next(), Some(&1));
/// assert_eq!(iter.next(), Some(&2));
/// assert_eq!(iter.next(), None);
/// ```
///
/// 因为传递给 `filter()` 的闭包需要用一个引用,并且许多迭代器迭代引用,所以这可能导致混乱的情况,其中闭包的类型是双引用:
///
///
/// ```
/// let a = [0, 1, 2];
///
/// let mut iter = a.iter().filter(|x| **x > 1); // 需要两个 *s!
///
/// assert_eq!(iter.next(), Some(&2));
/// assert_eq!(iter.next(), None);
/// ```
///
/// 通常在参数上使用解构来去掉一个:
///
/// ```
/// let a = [0, 1, 2];
///
/// let mut iter = a.iter().filter(|&x| *x > 1); // both & and *
///
/// assert_eq!(iter.next(), Some(&2));
/// assert_eq!(iter.next(), None);
/// ```
///
/// 或两个:
///
/// ```
/// let a = [0, 1, 2];
///
/// let mut iter = a.iter().filter(|&&x| x > 1); // 两个 &s
///
/// assert_eq!(iter.next(), Some(&2));
/// assert_eq!(iter.next(), None);
/// ```
///
/// 这些层。
///
/// 请注意,`iter.filter(f).next()` 等效于 `iter.find(f)`。
///
///
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn filter<P>(self, predicate: P) -> Filter<Self, P>
where
Self: Sized,
P: FnMut(&Self::Item) -> bool,
{
Filter::new(self, predicate)
}
/// 创建一个同时过滤和映射的迭代器。
///
/// 返回的迭代器只产生 `value`,而提供的闭包会返回 `Some(value)`。
///
/// `filter_map` 可用于使 [`filter`] 和 [`map`] 的链更简洁。
/// 下面的示例显示了如何将 `map().filter().map()` 缩短为 `filter_map` 的单个调用。
///
///
/// [`filter`]: Iterator::filter
/// [`map`]: Iterator::map
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = ["1", "two", "NaN", "four", "5"];
///
/// let mut iter = a.iter().filter_map(|s| s.parse().ok());
///
/// assert_eq!(iter.next(), Some(1));
/// assert_eq!(iter.next(), Some(5));
/// assert_eq!(iter.next(), None);
/// ```
///
/// 这是相同的示例,但使用 [`filter`] 和 [`map`]:
///
/// ```
/// let a = ["1", "two", "NaN", "four", "5"];
/// let mut iter = a.iter().map(|s| s.parse()).filter(|s| s.is_ok()).map(|s| s.unwrap());
/// assert_eq!(iter.next(), Some(1));
/// assert_eq!(iter.next(), Some(5));
/// assert_eq!(iter.next(), None);
/// ```
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn filter_map<B, F>(self, f: F) -> FilterMap<Self, F>
where
Self: Sized,
F: FnMut(Self::Item) -> Option<B>,
{
FilterMap::new(self, f)
}
/// 创建一个迭代器,该迭代器给出当前迭代次数以及下一个值。
///
/// 返回的迭代器产生对 `(i, val)`,其中 `i` 是当前迭代索引,`val` 是迭代器返回的值。
///
///
/// `enumerate()` 保持其计数为 [`usize`]。
/// 如果要使用其他大小的整数进行计数,则 [`zip`] 函数提供了类似的功能。
///
/// # 溢出行为
///
/// 该方法无法防止溢出,因此枚举多个 [`usize::MAX`] 元素会产生错误的结果或 panics。
/// 如果启用了调试断言,则将保证 panic。
///
/// # Panics
///
/// 如果要返回的索引将溢出 [`usize`],则返回的迭代器可能为 panic。
///
/// [`zip`]: Iterator::zip
///
/// # Examples
///
/// ```
/// let a = ['a', 'b', 'c'];
///
/// let mut iter = a.iter().enumerate();
///
/// assert_eq!(iter.next(), Some((0, &'a')));
/// assert_eq!(iter.next(), Some((1, &'b')));
/// assert_eq!(iter.next(), Some((2, &'c')));
/// assert_eq!(iter.next(), None);
/// ```
///
///
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn enumerate(self) -> Enumerate<Self>
where
Self: Sized,
{
Enumerate::new(self)
}
/// 创建一个迭代器,它可以使用 [`peek`] 和 [`peek_mut`] 方法查看迭代器的下一个元素而不消耗它。有关更多信息,请参见他们的文档。
///
/// 注意,第一次调用 [`peek`] 或 [`peek_mut`] 时,底层迭代器仍然在前进:为了检索下一个元素,在底层迭代器上调用 [`next`],因此会产生任何副作用 (即
/// 除了获取 [`next`] 方法的下一个值之外,其他所有操作都将发生。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let xs = [1, 2, 3];
///
/// let mut iter = xs.iter().peekable();
///
/// // peek() 让我们能看到未来
/// assert_eq!(iter.peek(), Some(&&1));
/// assert_eq!(iter.next(), Some(&1));
///
/// assert_eq!(iter.next(), Some(&2));
///
/// // 我们可以多次 peek(),迭代器不会前进
/// assert_eq!(iter.peek(), Some(&&3));
/// assert_eq!(iter.peek(), Some(&&3));
///
/// assert_eq!(iter.next(), Some(&3));
///
/// // 迭代器完成后,peek() 也是如此
/// assert_eq!(iter.peek(), None);
/// assert_eq!(iter.next(), None);
/// ```
///
/// 使用 [`peek_mut`] 在不推进迭代器的情况下改变下一个项:
///
/// ```
/// let xs = [1, 2, 3];
///
/// let mut iter = xs.iter().peekable();
///
/// // `peek_mut()` 让我们看到了 future
/// assert_eq!(iter.peek_mut(), Some(&mut &1));
/// assert_eq!(iter.peek_mut(), Some(&mut &1));
/// assert_eq!(iter.next(), Some(&1));
///
/// if let Some(mut p) = iter.peek_mut() {
/// assert_eq!(*p, &2);
/// // 将一个值放入迭代器
/// *p = &1000;
/// }
///
/// // 随着迭代器的继续,该值重新出现
/// assert_eq!(iter.collect::<Vec<_>>(), vec![&1000, &3]);
/// ```
/// [`peek`]: Peekable::peek
/// [`peek_mut`]: Peekable::peek_mut
/// [`next`]: Iterator::next
///
///
///
///
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn peekable(self) -> Peekable<Self>
where
Self: Sized,
{
Peekable::new(self)
}
/// 创建一个迭代器,该迭代器基于谓词 [`skip`] 元素。
///
/// [`skip`]: Iterator::skip
///
/// `skip_while()` 将闭包作为参数。它将在迭代器的每个元素上调用此闭包,并忽略元素,直到返回 `false`。
///
/// 返回 `false` 后,`skip_while () ` 的工作结束,并产生元素的剩余部分。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [-1i32, 0, 1];
///
/// let mut iter = a.iter().skip_while(|x| x.is_negative());
///
/// assert_eq!(iter.next(), Some(&0));
/// assert_eq!(iter.next(), Some(&1));
/// assert_eq!(iter.next(), None);
/// ```
///
/// 因为传递给 `skip_while()` 的闭包需要一个引用,并且许多迭代器都在引用上进行迭代,所以这会导致一种可能令人困惑的情况,其中闭包参数的类型是双引用:
///
///
/// ```
/// let a = [-1, 0, 1];
///
/// let mut iter = a.iter().skip_while(|x| **x < 0); // 需要两个 *s!
///
/// assert_eq!(iter.next(), Some(&0));
/// assert_eq!(iter.next(), Some(&1));
/// assert_eq!(iter.next(), None);
/// ```
///
/// 在初始 `false` 之后停止:
///
/// ```
/// let a = [-1, 0, 1, -2];
///
/// let mut iter = a.iter().skip_while(|x| **x < 0);
///
/// assert_eq!(iter.next(), Some(&0));
/// assert_eq!(iter.next(), Some(&1));
///
/// // 虽然这本来是错误的,但是由于我们已经得到了错误,所以不再使用 skip_while()
/////
/// assert_eq!(iter.next(), Some(&-2));
///
/// assert_eq!(iter.next(), None);
/// ```
///
///
///
///
#[inline]
#[doc(alias = "drop_while")]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn skip_while<P>(self, predicate: P) -> SkipWhile<Self, P>
where
Self: Sized,
P: FnMut(&Self::Item) -> bool,
{
SkipWhile::new(self, predicate)
}
/// 创建一个迭代器,该迭代器根据谓词产生元素。
///
/// `take_while()` 将闭包作为参数。它将在迭代器的每个元素上调用此闭包,并在返回 `true` 时产生 yield 元素。
///
/// 返回 `false` 后,`take_while () ` 的工作结束,并且元素的剩余部分被忽略。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [-1i32, 0, 1];
///
/// let mut iter = a.iter().take_while(|x| x.is_negative());
///
/// assert_eq!(iter.next(), Some(&-1));
/// assert_eq!(iter.next(), None);
/// ```
///
/// 因为传递给 `take_while()` 的闭包需要用一个引用,并且许多迭代器迭代引用,所以这可能导致混乱的情况,其中闭包的类型是双引用:
///
///
/// ```
/// let a = [-1, 0, 1];
///
/// let mut iter = a.iter().take_while(|x| **x < 0); // 需要两个 *s!
///
/// assert_eq!(iter.next(), Some(&-1));
/// assert_eq!(iter.next(), None);
/// ```
///
/// 在初始 `false` 之后停止:
///
/// ```
/// let a = [-1, 0, 1, -2];
///
/// let mut iter = a.iter().take_while(|x| **x < 0);
///
/// assert_eq!(iter.next(), Some(&-1));
///
/// // 我们有更多小于零的元素,但是由于我们已经得到了错误,因此不再使用 take_while()
/////
/// assert_eq!(iter.next(), None);
/// ```
///
/// 因为 `take_while()` 需要查看该值以查看是否应包含它,所以使用迭代器的人将看到它已被删除:
///
/// ```
/// let a = [1, 2, 3, 4];
/// let mut iter = a.iter();
///
/// let result: Vec<i32> = iter.by_ref()
/// .take_while(|n| **n != 3)
/// .cloned()
/// .collect();
///
/// assert_eq!(result, &[1, 2]);
///
/// let result: Vec<i32> = iter.cloned().collect();
///
/// assert_eq!(result, &[4]);
/// ```
///
/// `3` 不再存在,因为它已被消耗以查看迭代是否应该停止,但并未放回到迭代器中。
///
///
///
///
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn take_while<P>(self, predicate: P) -> TakeWhile<Self, P>
where
Self: Sized,
P: FnMut(&Self::Item) -> bool,
{
TakeWhile::new(self, predicate)
}
/// 创建一个迭代器,该迭代器均基于谓词和映射生成元素。
///
/// `map_while()` 将闭包作为参数。
/// 它将在迭代器的每个元素上调用此闭包,并在返回 [`Some(_)`][`Some`] 时产生元素。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [-1i32, 4, 0, 1];
///
/// let mut iter = a.iter().map_while(|x| 16i32.checked_div(*x));
///
/// assert_eq!(iter.next(), Some(-16));
/// assert_eq!(iter.next(), Some(4));
/// assert_eq!(iter.next(), None);
/// ```
///
/// 这是相同的示例,但使用 [`take_while`] 和 [`map`]:
///
/// [`take_while`]: Iterator::take_while
/// [`map`]: Iterator::map
///
/// ```
/// let a = [-1i32, 4, 0, 1];
///
/// let mut iter = a.iter()
/// .map(|x| 16i32.checked_div(*x))
/// .take_while(|x| x.is_some())
/// .map(|x| x.unwrap());
///
/// assert_eq!(iter.next(), Some(-16));
/// assert_eq!(iter.next(), Some(4));
/// assert_eq!(iter.next(), None);
/// ```
///
/// 在初始 [`None`] 之后停止:
///
/// ```
/// let a = [0, 1, 2, -3, 4, 5, -6];
///
/// let iter = a.iter().map_while(|x| u32::try_from(*x).ok());
/// let vec = iter.collect::<Vec<_>>();
///
/// // 我们还有更多可能适合 u32 (4,5) 的元素,但是 `map_while` 为 `-3` 返回了 `None` (因为 `predicate` 返回了 `None`),而 `collect` 在遇到的第一个 `None` 处停止。
/////
/// assert_eq!(vec, vec![0, 1, 2]);
/// ```
///
/// 因为 `map_while()` 需要查看该值以查看是否应包含它,所以使用迭代器的人将看到它已被删除:
///
///
/// ```
/// let a = [1, 2, -3, 4];
/// let mut iter = a.iter();
///
/// let result: Vec<u32> = iter.by_ref()
/// .map_while(|n| u32::try_from(*n).ok())
/// .collect();
///
/// assert_eq!(result, &[1, 2]);
///
/// let result: Vec<i32> = iter.cloned().collect();
///
/// assert_eq!(result, &[4]);
/// ```
///
/// `-3` 不再存在,因为它已被消耗以查看迭代是否应该停止,但并未放回到迭代器中。
///
/// 请注意,与 [`take_while`] 不同,此迭代器是不融合的。
/// 还没有指定返回第一个 [`None`] 之后此迭代器返回的内容。
/// 如果需要融合迭代器,请使用 [`fuse`]。
///
/// [`fuse`]: Iterator::fuse
///
///
///
#[inline]
#[stable(feature = "iter_map_while", since = "1.57.0")]
#[rustc_do_not_const_check]
fn map_while<B, P>(self, predicate: P) -> MapWhile<Self, P>
where
Self: Sized,
P: FnMut(Self::Item) -> Option<B>,
{
MapWhile::new(self, predicate)
}
/// 创建一个跳过前 `n` 个元素的迭代器。
///
/// `skip(n)` 跳过元素,直到跳过 `n` 元素或到达迭代器的末尾 (以先发生者为准)。之后,产生所有剩余的元素。
///
/// 特别是,如果原始迭代器太短,则返回的迭代器为空。
///
/// 而不是直接覆盖此方法,而是覆盖 `nth` 方法。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
///
/// let mut iter = a.iter().skip(2);
///
/// assert_eq!(iter.next(), Some(&3));
/// assert_eq!(iter.next(), None);
/// ```
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn skip(self, n: usize) -> Skip<Self>
where
Self: Sized,
{
Skip::new(self, n)
}
/// 创建一个迭代器,它产生第一个 `n` 元素,如果底层迭代器提前结束,则产生更少的元素。
///
/// `take(n)` 产生元素,直到产生 `n` 元素或到达迭代器的末尾 (以先发生者为准)。
/// 如果原始迭代器包含至少 `n` 个元素,则返回的迭代器是一个长度为 `n` 的前缀,否则它包含原始迭代器的所有 (少于 `n`) 个元素。
///
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
///
/// let mut iter = a.iter().take(2);
///
/// assert_eq!(iter.next(), Some(&1));
/// assert_eq!(iter.next(), Some(&2));
/// assert_eq!(iter.next(), None);
/// ```
///
/// `take()` 通常与无限迭代器一起使用,以使其成为有限的:
///
/// ```
/// let mut iter = (0..).take(3);
///
/// assert_eq!(iter.next(), Some(0));
/// assert_eq!(iter.next(), Some(1));
/// assert_eq!(iter.next(), Some(2));
/// assert_eq!(iter.next(), None);
/// ```
///
/// 如果少于 `n` 个元素可用,`take` 会将自身限制为底层迭代器的大小:
///
/// ```
/// let v = [1, 2];
/// let mut iter = v.into_iter().take(5);
/// assert_eq!(iter.next(), Some(1));
/// assert_eq!(iter.next(), Some(2));
/// assert_eq!(iter.next(), None);
/// ```
///
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn take(self, n: usize) -> Take<Self>
where
Self: Sized,
{
Take::new(self, n)
}
/// 一个迭代器适配器,它与 [`fold`] 一样保存内部状态,但与 [`fold`] 不同,它生成一个新的迭代器。
///
/// [`fold`]: Iterator::fold
///
/// `scan()` 有两个参数,一个初始值作为内部状态的种子,一个闭包有两个参数,第一个是:循环引用到内部状态,第二个是迭代器元素。
///
/// 闭包可以分配给内部状态,以在迭代之间共享状态。
///
/// 在迭代中,闭包将应用于迭代器的每个元素,闭包的返回值 [`Option`] 由 `next` 方法返回。
/// 因此闭包可以返回 `Some(value)` 以产生 `value`,或返回 `None` 以结束迭代。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3, 4];
///
/// let mut iter = a.iter().scan(1, |state, &x| {
/// // 每次迭代,我们将状态乘以元素 ...
/// *state = *state * x;
///
/// // ... 如果状态超过 6,则终止
/// if *state > 6 {
/// return None;
/// }
/// // ... else yield 状态的否定
/// Some(-*state)
/// });
///
/// assert_eq!(iter.next(), Some(-1));
/// assert_eq!(iter.next(), Some(-2));
/// assert_eq!(iter.next(), Some(-6));
/// assert_eq!(iter.next(), None);
/// ```
///
///
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn scan<St, B, F>(self, initial_state: St, f: F) -> Scan<Self, St, F>
where
Self: Sized,
F: FnMut(&mut St, Self::Item) -> Option<B>,
{
Scan::new(self, initial_state, f)
}
/// 创建一个迭代器,其工作方式类似于 map,但它会将嵌套的结构展平。
///
/// [`map`] 适配器非常有用,但仅当闭包参数产生值时才使用。
/// 如果它产生一个迭代器,则存在一个额外的间接层。
/// `flat_map()` 将自行删除这个额外的层。
///
/// 您可以把 `flat_map(f)` 视为 [`map`] 的语义等价物,然后把 [`flatten`] 看作是 `map(f).flatten()`。
///
/// 关于 `flat_map()` 的另一种方式: [`map`] 的闭包为每个元素返回一个项,而 `flat_map () ` 的闭包为每个元素返回一个迭代器。
///
///
/// [`map`]: Iterator::map
/// [`flatten`]: Iterator::flatten
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let words = ["alpha", "beta", "gamma"];
///
/// // chars() 返回一个迭代器
/// let merged: String = words.iter()
/// .flat_map(|s| s.chars())
/// .collect();
/// assert_eq!(merged, "alphabetagamma");
/// ```
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn flat_map<U, F>(self, f: F) -> FlatMap<Self, U, F>
where
Self: Sized,
U: IntoIterator,
F: FnMut(Self::Item) -> U,
{
FlatMap::new(self, f)
}
/// 创建一个可简化嵌套结构体的迭代器。
///
/// 当您具有迭代器的迭代器或可以转换为迭代器的事物的迭代器并且要删除一个间接级别时,此功能很有用。
///
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let data = vec![vec![1, 2, 3, 4], vec![5, 6]];
/// let flattened = data.into_iter().flatten().collect::<Vec<u8>>();
/// assert_eq!(flattened, &[1, 2, 3, 4, 5, 6]);
/// ```
///
/// 映射然后展平:
///
/// ```
/// let words = ["alpha", "beta", "gamma"];
///
/// // chars() 返回一个迭代器
/// let merged: String = words.iter()
/// .map(|s| s.chars())
/// .flatten()
/// .collect();
/// assert_eq!(merged, "alphabetagamma");
/// ```
///
/// 您也可以用 [`flat_map()`] 来重写它,在这种情况下最好使用 [`flat_map()`],因为它可以更清楚地传达意图:
///
/// ```
/// let words = ["alpha", "beta", "gamma"];
///
/// // chars() 返回一个迭代器
/// let merged: String = words.iter()
/// .flat_map(|s| s.chars())
/// .collect();
/// assert_eq!(merged, "alphabetagamma");
/// ```
///
/// 展平适用于任何 `IntoIterator` 类型,包括 `Option` 和 `Result`:
///
/// ```
/// let options = vec![Some(123), Some(321), None, Some(231)];
/// let flattened_options: Vec<_> = options.into_iter().flatten().collect();
/// assert_eq!(flattened_options, vec![123, 321, 231]);
///
/// let results = vec![Ok(123), Ok(321), Err(456), Ok(231)];
/// let flattened_results: Vec<_> = results.into_iter().flatten().collect();
/// assert_eq!(flattened_results, vec![123, 321, 231]);
/// ```
///
/// 展平一次只能删除一层嵌套:
///
/// ```
/// let d3 = [[[1, 2], [3, 4]], [[5, 6], [7, 8]]];
///
/// let d2 = d3.iter().flatten().collect::<Vec<_>>();
/// assert_eq!(d2, [&[1, 2], &[3, 4], &[5, 6], &[7, 8]]);
///
/// let d1 = d3.iter().flatten().flatten().collect::<Vec<_>>();
/// assert_eq!(d1, [&1, &2, &3, &4, &5, &6, &7, &8]);
/// ```
///
/// 在这里,我们看到 `flatten()` 不执行深度展平。
/// 相反,仅删除了一层嵌套。也就是说,如果您用 `flatten()` 三维数组,则结果将是二维而不是一维的。
/// 要获得一维结构体,您必须再次 `flatten()`。
///
/// [`flat_map()`]: Iterator::flat_map
///
///
///
///
#[inline]
#[stable(feature = "iterator_flatten", since = "1.29.0")]
#[rustc_do_not_const_check]
fn flatten(self) -> Flatten<Self>
where
Self: Sized,
Self::Item: IntoIterator,
{
Flatten::new(self)
}
/// 创建一个迭代器,该迭代器在第一个 [`None`] 之后结束。
///
/// 迭代器返回 [`None`] 之后,future 调用可能会或可能不会再次产生 [`Some(T)`]。
/// `fuse()` 适配了一个迭代器,确保在给定 [`None`] 之后,它将永远返回 [`None`]。
///
///
/// 请注意,[`Fuse`] 包装器对实现 [`FusedIterator`] trait 的迭代器是无操作的。
/// 因此,如果 [`FusedIterator`] trait 实现不当,`fuse()` 可能会出现错误行为。
///
/// [`Some(T)`]: Some
/// [`FusedIterator`]: crate::iter::FusedIterator
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// // 一个在 Some 和 None 之间交替的迭代器
/// struct Alternate {
/// state: i32,
/// }
///
/// impl Iterator for Alternate {
/// type Item = i32;
///
/// fn next(&mut self) -> Option<i32> {
/// let val = self.state;
/// self.state = self.state + 1;
///
/// // 如果是偶数,则为 Some(i32),否则为 None
/// if val % 2 == 0 {
/// Some(val)
/// } else {
/// None
/// }
/// }
/// }
///
/// let mut iter = Alternate { state: 0 };
///
/// // 我们可以看到我们的迭代器来回走动
/// assert_eq!(iter.next(), Some(0));
/// assert_eq!(iter.next(), None);
/// assert_eq!(iter.next(), Some(2));
/// assert_eq!(iter.next(), None);
///
/// // 然而,一旦我们 fuse 它...
/// let mut iter = iter.fuse();
///
/// assert_eq!(iter.next(), Some(4));
/// assert_eq!(iter.next(), None);
///
/// // 第一次之后它将始终返回 `None`。
/// assert_eq!(iter.next(), None);
/// assert_eq!(iter.next(), None);
/// assert_eq!(iter.next(), None);
/// ```
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn fuse(self) -> Fuse<Self>
where
Self: Sized,
{
Fuse::new(self)
}
/// 对迭代器的每个元素执行某些操作,将值传递给它。
///
/// 使用迭代器时,通常会将其中的几个链接在一起。
/// 在处理此类代码时,您可能想要切换到管道中各个部分的情况。为此,将一个调用插入 `inspect()`。
///
/// `inspect()` 用作调试工具要比最终代码中存在的更为普遍,但是在某些情况下,如果需要先记录错误然后丢弃,应用程序可能会发现它很有用。
///
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 4, 2, 3];
///
/// // 该迭代器序列很复杂。
/// let sum = a.iter()
/// .cloned()
/// .filter(|x| x % 2 == 0)
/// .fold(0, |sum, i| sum + i);
///
/// println!("{sum}");
///
/// // 让我们添加一些 inspect() 调用以调查正在发生的事情
/// let sum = a.iter()
/// .cloned()
/// .inspect(|x| println!("about to filter: {x}"))
/// .filter(|x| x % 2 == 0)
/// .inspect(|x| println!("made it through filter: {x}"))
/// .fold(0, |sum, i| sum + i);
///
/// println!("{sum}");
/// ```
///
/// 这将打印:
///
/// ```text
/// 6
/// about to filter: 1
/// about to filter: 4
/// made it through filter: 4
/// about to filter: 2
/// made it through filter: 2
/// about to filter: 3
/// 6
/// ```
///
/// 在丢弃错误之前记录错误:
///
/// ```
/// let lines = ["1", "2", "a"];
///
/// let sum: i32 = lines
/// .iter()
/// .map(|line| line.parse::<i32>())
/// .inspect(|num| {
/// if let Err(ref e) = *num {
/// println!("Parsing error: {e}");
/// }
/// })
/// .filter_map(Result::ok)
/// .sum();
///
/// println!("Sum: {sum}");
/// ```
///
/// 这将打印:
///
/// ```text
/// Parsing error: invalid digit found in string
/// Sum: 3
/// ```
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn inspect<F>(self, f: F) -> Inspect<Self, F>
where
Self: Sized,
F: FnMut(&Self::Item),
{
Inspect::new(self, f)
}
/// 借用一个迭代器,而不是使用它。
///
/// 这对于允许应用迭代器适配器同时仍保留原始迭代器的所有权很有用。
///
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let mut words = ["hello", "world", "of", "Rust"].into_iter();
///
/// // 以前两个单词为例。
/// let hello_world: Vec<_> = words.by_ref().take(2).collect();
/// assert_eq!(hello_world, vec!["hello", "world"]);
///
/// // 收集剩下的单词。
/// // 我们只能这样做,因为我们之前使用了 `by_ref`。
/// let of_rust: Vec<_> = words.collect();
/// assert_eq!(of_rust, vec!["of", "Rust"]);
/// ```
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn by_ref(&mut self) -> &mut Self
where
Self: Sized,
{
self
}
/// 将迭代器转换为集合。
///
/// `collect()` 可以将任何可迭代的东西变成一个相关的集合。
/// 这是在各种上下文中使用的标准库中功能更强大的方法之一。
///
/// 使用 `collect()` 的最基本模式是将一个集合转换为另一个集合。
/// 您进行了一个收集,在其上调用 [`iter`],进行了一堆转换,最后添加 `collect()`。
///
/// `collect()` 还可以创建非典型集合类型的实例。
/// 例如,可以从 [`char`] 构建一个 [`String`],并且可以将 [`Result<T, E>`][`Result`] 项的迭代器收集到 `Result<Collection<T>, E>` 中。
///
/// 有关更多信息,请参见下面的示例。
///
/// 由于 `collect()` 非常通用,因此可能导致类型推断问题。
/// 因此,`collect()` 是少数几次您会看到被亲切地称为 'turbofish': `::<>` 的语法之一。
/// 这有助于推理算法特别了解您要收集到的集合。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
///
/// let doubled: Vec<i32> = a.iter()
/// .map(|&x| x * 2)
/// .collect();
///
/// assert_eq!(vec![2, 4, 6], doubled);
/// ```
///
/// 请注意,我们需要在左侧使用 `: Vec<i32>`。这是因为我们可以代替收集到例如 [`VecDeque<T>`] 中:
///
/// [`VecDeque<T>`]: ../../std/collections/struct.VecDeque.html
///
/// ```
/// use std::collections::VecDeque;
///
/// let a = [1, 2, 3];
///
/// let doubled: VecDeque<i32> = a.iter().map(|&x| x * 2).collect();
///
/// assert_eq!(2, doubled[0]);
/// assert_eq!(4, doubled[1]);
/// assert_eq!(6, doubled[2]);
/// ```
///
/// 使用 'turbofish' 而不是注解 `doubled`:
///
/// ```
/// let a = [1, 2, 3];
///
/// let doubled = a.iter().map(|x| x * 2).collect::<Vec<i32>>();
///
/// assert_eq!(vec![2, 4, 6], doubled);
/// ```
///
/// 因为 `collect()` 只关心您要收集的内容,所以您仍然可以将局部类型提示 `_` 与 turbfish 一起使用:
///
/// ```
/// let a = [1, 2, 3];
///
/// let doubled = a.iter().map(|x| x * 2).collect::<Vec<_>>();
///
/// assert_eq!(vec![2, 4, 6], doubled);
/// ```
///
/// 使用 `collect()` 生成 [`String`]:
///
/// ```
/// let chars = ['g', 'd', 'k', 'k', 'n'];
///
/// let hello: String = chars.iter()
/// .map(|&x| x as u8)
/// .map(|x| (x + 1) as char)
/// .collect();
///
/// assert_eq!("hello", hello);
/// ```
///
/// 如果您有 [`Result<T, E>`][`Result`],您可以使用 `collect()` 来查看它们是否失败:
///
/// ```
/// let results = [Ok(1), Err("nope"), Ok(3), Err("bad")];
///
/// let result: Result<Vec<_>, &str> = results.iter().cloned().collect();
///
/// // 给我们第一个错误
/// assert_eq!(Err("nope"), result);
///
/// let results = [Ok(1), Ok(3)];
///
/// let result: Result<Vec<_>, &str> = results.iter().cloned().collect();
///
/// // 给我们答案列表
/// assert_eq!(Ok(vec![1, 3]), result);
/// ```
///
/// [`iter`]: Iterator::next
/// [`String`]: ../../std/string/struct.String.html
/// [`char`]: type@char
///
///
///
///
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[must_use = "if you really need to exhaust the iterator, consider `.for_each(drop)` instead"]
#[cfg_attr(not(test), rustc_diagnostic_item = "iterator_collect_fn")]
#[rustc_do_not_const_check]
fn collect<B: FromIterator<Self::Item>>(self) -> B
where
Self: Sized,
{
FromIterator::from_iter(self)
}
/// 错误地将迭代器转换为集合,如果遇到失败就短路。
///
/// `try_collect()` 是 [`collect()`][`collect`] 的变体,它允许在收集期间进行可能出错的转换。
/// 它的主要用例是简化从产生 [`Option<T>`][`Option`] 到 `Option<Collection<T>>` 的迭代器的转换,或者类似地用于其他 [`Try`] 类型 (例如
/// [`Result`]).
///
/// 重要的是,`try_collect()` 不需要外部 [`Try`] 类型也实现 [`FromIterator`];
/// 只有在 `Try::Output` 上产生的内部类型必须实现它。
/// 具体来说,这意味着收集到 `ControlFlow<_, Vec<i32>>` 是有效的,因为 `Vec<i32>` 实现了 [`FromIterator`],即使 [`ControlFlow`] 没有实现。
///
/// 另外,如果在 `try_collect()` 期间遇到失败,迭代器仍然有效,可以继续使用,在这种情况下,它将在触发失败的元素之后继续迭代。
/// 有关其工作原理的示例,请参见下面的最后一个示例。
///
/// # Examples
/// 成功将 `Option<i32>` 的一个迭代器收集到 `Option<Vec<i32>>` 中:
///
/// ```
/// #![feature(iterator_try_collect)]
///
/// let u = vec![Some(1), Some(2), Some(3)];
/// let v = u.into_iter().try_collect::<Vec<i32>>();
/// assert_eq!(v, Some(vec![1, 2, 3]));
/// ```
///
/// 未能以同样的方式收集:
///
/// ```
/// #![feature(iterator_try_collect)]
///
/// let u = vec![Some(1), Some(2), None, Some(3)];
/// let v = u.into_iter().try_collect::<Vec<i32>>();
/// assert_eq!(v, None);
/// ```
///
/// 一个类似的例子,但使用了 `Result`:
///
/// ```
/// #![feature(iterator_try_collect)]
///
/// let u: Vec<Result<i32, ()>> = vec![Ok(1), Ok(2), Ok(3)];
/// let v = u.into_iter().try_collect::<Vec<i32>>();
/// assert_eq!(v, Ok(vec![1, 2, 3]));
///
/// let u = vec![Ok(1), Ok(2), Err(()), Ok(3)];
/// let v = u.into_iter().try_collect::<Vec<i32>>();
/// assert_eq!(v, Err(()));
/// ```
///
/// 最后,即使 [`ControlFlow`] 也可以工作,尽管它没有实现 [`FromIterator`]。另请注意,即使遇到失败,迭代器也可以继续使用:
///
/// ```
/// #![feature(iterator_try_collect)]
///
/// use core::ops::ControlFlow::{Break, Continue};
///
/// let u = [Continue(1), Continue(2), Break(3), Continue(4), Continue(5)];
/// let mut it = u.into_iter();
///
/// let v = it.try_collect::<Vec<_>>();
/// assert_eq!(v, Break(3));
///
/// let v = it.try_collect::<Vec<_>>();
/// assert_eq!(v, Continue(vec![4, 5]));
/// ```
///
/// [`collect`]: Iterator::collect
///
///
///
#[inline]
#[unstable(feature = "iterator_try_collect", issue = "94047")]
#[rustc_do_not_const_check]
fn try_collect<B>(&mut self) -> ChangeOutputType<Self::Item, B>
where
Self: Sized,
<Self as Iterator>::Item: Try,
<<Self as Iterator>::Item as Try>::Residual: Residual<B>,
B: FromIterator<<Self::Item as Try>::Output>,
{
try_process(ByRefSized(self), |i| i.collect())
}
/// 将迭代器中的所有项收集到一个集合中。
///
/// 此方法使用迭代器并将其所有项添加到传递的集合中。然后返回集合,因此调用链可以继续。
///
/// 当您已经有了一个集合,并希望向其中添加迭代器项时,这很有用。
///
/// 此方法是调用 [Extend::extend](trait.Extend.html) 的便捷方法,但不是在集合上调用,而是在迭代器上调用。
///
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// #![feature(iter_collect_into)]
///
/// let a = [1, 2, 3];
/// let mut vec: Vec::<i32> = vec![0, 1];
///
/// a.iter().map(|&x| x * 2).collect_into(&mut vec);
/// a.iter().map(|&x| x * 10).collect_into(&mut vec);
///
/// assert_eq!(vec, vec![0, 1, 2, 4, 6, 10, 20, 30]);
/// ```
///
/// `Vec` 可以手动设置容量,以避免重新分配:
///
/// ```
/// #![feature(iter_collect_into)]
///
/// let a = [1, 2, 3];
/// let mut vec: Vec::<i32> = Vec::with_capacity(6);
///
/// a.iter().map(|&x| x * 2).collect_into(&mut vec);
/// a.iter().map(|&x| x * 10).collect_into(&mut vec);
///
/// assert_eq!(6, vec.capacity());
/// assert_eq!(vec, vec![2, 4, 6, 10, 20, 30]);
/// ```
///
/// 返回的可变引用可用于继续调用链:
///
/// ```
/// #![feature(iter_collect_into)]
///
/// let a = [1, 2, 3];
/// let mut vec: Vec::<i32> = Vec::with_capacity(6);
///
/// let count = a.iter().collect_into(&mut vec).iter().count();
///
/// assert_eq!(count, vec.len());
/// assert_eq!(vec, vec![1, 2, 3]);
///
/// let count = a.iter().collect_into(&mut vec).iter().count();
///
/// assert_eq!(count, vec.len());
/// assert_eq!(vec, vec![1, 2, 3, 1, 2, 3]);
/// ```
///
///
///
#[inline]
#[unstable(feature = "iter_collect_into", reason = "new API", issue = "94780")]
#[rustc_do_not_const_check]
fn collect_into<E: Extend<Self::Item>>(self, collection: &mut E) -> &mut E
where
Self: Sized,
{
collection.extend(self);
collection
}
/// 消耗一个迭代器,从中创建两个集合。
///
/// 传递给 `partition()` 的谓词可以返回 `true` 或 `false`。
/// `partition()` 返回一对,它返回 `true` 的所有元素,以及它返回 `false` 的所有元素。
///
///
/// 另请参见 [`is_partitioned()`] 和 [`partition_in_place()`]。
///
/// [`is_partitioned()`]: Iterator::is_partitioned
/// [`partition_in_place()`]: Iterator::partition_in_place
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
///
/// let (even, odd): (Vec<_>, Vec<_>) = a
/// .into_iter()
/// .partition(|n| n % 2 == 0);
///
/// assert_eq!(even, vec![2]);
/// assert_eq!(odd, vec![1, 3]);
/// ```
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn partition<B, F>(self, f: F) -> (B, B)
where
Self: Sized,
B: Default + Extend<Self::Item>,
F: FnMut(&Self::Item) -> bool,
{
#[inline]
fn extend<'a, T, B: Extend<T>>(
mut f: impl FnMut(&T) -> bool + 'a,
left: &'a mut B,
right: &'a mut B,
) -> impl FnMut((), T) + 'a {
move |(), x| {
if f(&x) {
left.extend_one(x);
} else {
right.extend_one(x);
}
}
}
let mut left: B = Default::default();
let mut right: B = Default::default();
self.fold((), extend(f, &mut left, &mut right));
(left, right)
}
/// 根据给定的谓词,对迭代器的元素进行就地重新排序,以使所有返回 `true` 的元素都在所有返回 `false` 的元素之前。
/// 返回找到的 `true` 元素的数量。
///
/// 未维护分区项的相对顺序。
///
/// # 当前实现
///
/// 当前算法试图找到谓词计算结果为假的第一个元素和它计算结果为真的最后一个元素,并重复交换它们。
///
///
/// 时间复杂度: *O*(*n*)
///
/// 另请参见 [`is_partitioned()`] 和 [`partition()`]。
///
/// [`is_partitioned()`]: Iterator::is_partitioned
/// [`partition()`]: Iterator::partition
///
/// # Examples
///
/// ```
/// #![feature(iter_partition_in_place)]
///
/// let mut a = [1, 2, 3, 4, 5, 6, 7];
///
/// // 在偶数和赔率之间进行适当的分区
/// let i = a.iter_mut().partition_in_place(|&n| n % 2 == 0);
///
/// assert_eq!(i, 3);
/// assert!(a[..i].iter().all(|&n| n % 2 == 0)); // evens
/// assert!(a[i..].iter().all(|&n| n % 2 == 1)); // odds
/// ```
///
#[unstable(feature = "iter_partition_in_place", reason = "new API", issue = "62543")]
#[rustc_do_not_const_check]
fn partition_in_place<'a, T: 'a, P>(mut self, ref mut predicate: P) -> usize
where
Self: Sized + DoubleEndedIterator<Item = &'a mut T>,
P: FnMut(&T) -> bool,
{
// FIXME: 我们应该担心计数溢出吗? 拥有超过 `usize::MAX` 可变引用的唯一方法是使用 ZST,这对分区没有用...
//
// 这些闭包工厂函数的存在是为了避免 `Self` 中的泛型。
#[inline]
fn is_false<'a, T>(
predicate: &'a mut impl FnMut(&T) -> bool,
true_count: &'a mut usize,
) -> impl FnMut(&&mut T) -> bool + 'a {
move |x| {
let p = predicate(&**x);
*true_count += p as usize;
!p
}
}
#[inline]
fn is_true<T>(predicate: &mut impl FnMut(&T) -> bool) -> impl FnMut(&&mut T) -> bool + '_ {
move |x| predicate(&**x)
}
// 重复查找第一个 `false` 并将其与最后一个 `true` 交换。
let mut true_count = 0;
while let Some(head) = self.find(is_false(predicate, &mut true_count)) {
if let Some(tail) = self.rfind(is_true(predicate)) {
crate::mem::swap(head, tail);
true_count += 1;
} else {
break;
}
}
true_count
}
/// 检查此迭代器的元素是否根据给定的谓词进行了分区,以便所有返回 `true` 的元素都在所有返回 `false` 的元素之前。
///
///
/// 另请参见 [`partition()`] 和 [`partition_in_place()`]。
///
/// [`partition()`]: Iterator::partition
/// [`partition_in_place()`]: Iterator::partition_in_place
///
/// # Examples
///
/// ```
/// #![feature(iter_is_partitioned)]
///
/// assert!("Iterator".chars().is_partitioned(char::is_uppercase));
/// assert!(!"IntoIterator".chars().is_partitioned(char::is_uppercase));
/// ```
#[unstable(feature = "iter_is_partitioned", reason = "new API", issue = "62544")]
#[rustc_do_not_const_check]
fn is_partitioned<P>(mut self, mut predicate: P) -> bool
where
Self: Sized,
P: FnMut(Self::Item) -> bool,
{
// 所有项测试 `true`,或者第一个子句在 `false` 处停止,然后我们检查之后没有更多的 `true` 项。
//
self.all(&mut predicate) || !self.any(predicate)
}
/// 一个迭代器方法,它只要成功返回就应用函数,并产生单个最终值。
///
/// `try_fold()` 有两个参数:一个初始值,一个闭包,有两个参数:一个 'accumulator' 和一个元素。
/// 闭包要么成功返回并返回累加器在下一次迭代中应具有的值,要么返回失败,返回错误值并立即将错误值传播回调用者 (short-circuiting)。
///
///
/// 初始值是累加器在第一次调用时将具有的值。如果对迭代器的每个元素成功应用闭包,`try_fold()` 将返回最终的累加器作为成功。
///
/// 当您拥有某个集合,并且希望从中产生单个值时,`fold` 非常有用。
///
/// # 实现者注意
///
/// 就此而言,其他几种 (forward) 方法都具有默认实现,因此,如果它可以做得比默认 `for` 循环实现更好,请尝试显式实现此方法。
///
/// 特别是,请尝试将此 `try_fold()` 放在组成此迭代器的内部部件上。
/// 如果需要多次调用,则 `?` 运算符可能会很方便地将累加器值链接在一起,但是要提防在这些早期返回之前需要保留的所有不变量。
/// 这是一种 `&mut self` 方法,因此在此处遇到错误后需要重新开始迭代。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
///
/// // 数组所有元素的校验和
/// let sum = a.iter().try_fold(0i8, |acc, &x| acc.checked_add(x));
///
/// assert_eq!(sum, Some(6));
/// ```
///
/// Short-circuiting:
///
/// ```
/// let a = [10, 20, 30, 100, 40, 50];
/// let mut it = a.iter();
///
/// // 加 100 元素时,此总和溢出
/// let sum = it.try_fold(0i8, |acc, &x| acc.checked_add(x));
/// assert_eq!(sum, None);
///
/// // 由于发生短路,因此其余元素仍可通过迭代器使用。
/////
/// assert_eq!(it.len(), 2);
/// assert_eq!(it.next(), Some(&40));
/// ```
///
/// 虽然您不能从 闭包 `break`,[`ControlFlow`] 类型允许类似的想法:
///
/// ```
/// use std::ops::ControlFlow;
///
/// let triangular = (1..30).try_fold(0_i8, |prev, x| {
/// if let Some(next) = prev.checked_add(x) {
/// ControlFlow::Continue(next)
/// } else {
/// ControlFlow::Break(prev)
/// }
/// });
/// assert_eq!(triangular, ControlFlow::Break(120));
///
/// let triangular = (1..30).try_fold(0_u64, |prev, x| {
/// if let Some(next) = prev.checked_add(x) {
/// ControlFlow::Continue(next)
/// } else {
/// ControlFlow::Break(prev)
/// }
/// });
/// assert_eq!(triangular, ControlFlow::Continue(435));
/// ```
///
///
///
///
///
///
///
///
///
///
///
///
#[inline]
#[stable(feature = "iterator_try_fold", since = "1.27.0")]
#[rustc_do_not_const_check]
fn try_fold<B, F, R>(&mut self, init: B, mut f: F) -> R
where
Self: Sized,
F: FnMut(B, Self::Item) -> R,
R: Try<Output = B>,
{
let mut accum = init;
while let Some(x) = self.next() {
accum = f(accum, x)?;
}
try { accum }
}
/// 一个迭代器方法,该方法将一个容易犯错的函数应用于迭代器中的每个项,在第一个错误处停止并返回该错误。
///
///
/// 也可以将其视为 [`for_each()`] 的错误形式或 [`try_fold()`] 的无状态版本。
///
/// [`for_each()`]: Iterator::for_each
/// [`try_fold()`]: Iterator::try_fold
///
/// # Examples
///
/// ```
/// use std::fs::rename;
/// use std::io::{stdout, Write};
/// use std::path::Path;
///
/// let data = ["no_tea.txt", "stale_bread.json", "torrential_rain.png"];
///
/// let res = data.iter().try_for_each(|x| writeln!(stdout(), "{x}"));
/// assert!(res.is_ok());
///
/// let mut it = data.iter().cloned();
/// let res = it.try_for_each(|x| rename(x, Path::new(x).with_extension("old")));
/// assert!(res.is_err());
/// // 它短路,因此其余项仍在迭代器中:
/// assert_eq!(it.next(), Some("stale_bread.json"));
/// ```
///
/// [`ControlFlow`] 类型可以与此方法一起用于在正常循环中使用 `break` 和 `continue` 的情况:
///
/// ```
/// use std::ops::ControlFlow;
///
/// let r = (2..100).try_for_each(|x| {
/// if 323 % x == 0 {
/// return ControlFlow::Break(x)
/// }
///
/// ControlFlow::Continue(())
/// });
/// assert_eq!(r, ControlFlow::Break(17));
/// ```
///
///
#[inline]
#[stable(feature = "iterator_try_fold", since = "1.27.0")]
#[rustc_do_not_const_check]
fn try_for_each<F, R>(&mut self, f: F) -> R
where
Self: Sized,
F: FnMut(Self::Item) -> R,
R: Try<Output = ()>,
{
#[inline]
fn call<T, R>(mut f: impl FnMut(T) -> R) -> impl FnMut((), T) -> R {
move |(), x| f(x)
}
self.try_fold((), call(f))
}
/// 通过应用操作将每个元素 `fold` 到一个累加器中,返回最终结果。
///
/// `fold()` 有两个参数:一个初始值,一个闭包,有两个参数:一个 'accumulator' 和一个元素。
/// 闭包返回累加器在下一次迭代中应具有的值。
///
/// 初始值是累加器在第一次调用时将具有的值。
///
/// 在将此闭包应用于迭代器的每个元素之后,`fold()` 返回累加器。
///
/// 该操作有时称为 'reduce' 或 'inject'。
///
/// 当您拥有某个集合,并且希望从中产生单个值时,`fold` 非常有用。
///
/// Note: `fold()` 和遍历整个迭代器的类似方法可能不会因无限迭代器而终止,即使在 traits 上,其结果在有限时间内是可确定的。
///
/// Note: 如果累加器类型和项类型相同,则可以使用 [`reduce()`] 将第一个元素用作初始值。
///
/// Note: `fold()` 以*左关联*方式组合元素。
/// 对于像 `+` 这样的关联性,元素组合的顺序并不重要,但对于像 `-` 这样的非关联性,顺序会影响最终结果。
/// 对于 `fold()` 的*右关联*版本,请参见 [`DoubleEndedIterator::rfold()`]。
///
/// # 实现者注意
///
/// 就此而言,其他几种 (forward) 方法都具有默认实现,因此,如果它可以做得比默认 `for` 循环实现更好,请尝试显式实现此方法。
///
///
/// 特别是,请尝试将此 `fold()` 放在组成此迭代器的内部部件上。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
///
/// // 数组所有元素的总和
/// let sum = a.iter().fold(0, |acc, x| acc + x);
///
/// assert_eq!(sum, 6);
/// ```
///
/// 让我们在这里遍历迭代的每个步骤:
///
/// | element | acc | x | result |
/// |---------|-----|---|--------|
/// | | 0 | | |
/// | 1 | 0 | 1 | 1 |
/// | 2 | 1 | 2 | 3 |
/// | 3 | 3 | 3 | 6 |
///
/// 所以,我们的最终结果,`6`。
///
/// 这个例子演示了 `fold()` 的左关联特性:
/// 它构建一个字符串,从一个初始值开始,从前面到后面的每个元素继续:
///
/// ```
/// let numbers = [1, 2, 3, 4, 5];
///
/// let zero = "0".to_string();
///
/// let result = numbers.iter().fold(zero, |acc, &x| {
/// format!("({acc} + {x})")
/// });
///
/// assert_eq!(result, "(((((0 + 1) + 2) + 3) + 4) + 5)");
/// ```
/// 对于那些不经常使用迭代器的人,通常会使用 `for` 循环并附带一系列要建立结果的列表。那些可以变成 `fold () `s:
///
/// [`for`]: ../../book/ch03-05-control-flow.html#looping-through-a-collection-with-for
///
/// ```
/// let numbers = [1, 2, 3, 4, 5];
///
/// let mut result = 0;
///
/// // for 循环:
/// for i in &numbers {
/// result = result + i;
/// }
///
/// // fold:
/// let result2 = numbers.iter().fold(0, |acc, &x| acc + x);
///
/// // 他们是一样的
/// assert_eq!(result, result2);
/// ```
///
/// [`reduce()`]: Iterator::reduce
///
///
///
///
///
///
///
///
///
///
///
///
///
///
#[doc(alias = "inject", alias = "foldl")]
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn fold<B, F>(mut self, init: B, mut f: F) -> B
where
Self: Sized,
F: FnMut(B, Self::Item) -> B,
{
let mut accum = init;
while let Some(x) = self.next() {
accum = f(accum, x);
}
accum
}
/// 通过重复应用缩减操作,将元素缩减为一个。
///
/// 如果迭代器为空,则返回 [`None`]; 否则,返回 [`None`]。否则,返回减少的结果。
///
/// Reduce 函数是一个闭包,有两个参数:一个 'accumulator' 和一个元素。
/// 对于具有至少一个元素的迭代器,这与 [`fold()`] 相同,将迭代器的第一个元素作为初始累加器值,将每个后续元素 fold 到其中。
///
///
/// [`fold()`]: Iterator::fold
///
/// # Example
///
/// ```
/// let reduced: i32 = (1..10).reduce(|acc, e| acc + e).unwrap();
/// assert_eq!(reduced, 45);
///
/// // 这相当于用 `fold` 来做:
/// let folded: i32 = (1..10).fold(0, |acc, e| acc + e);
/// assert_eq!(reduced, folded);
/// ```
///
///
///
#[inline]
#[stable(feature = "iterator_fold_self", since = "1.51.0")]
#[rustc_do_not_const_check]
fn reduce<F>(mut self, f: F) -> Option<Self::Item>
where
Self: Sized,
F: FnMut(Self::Item, Self::Item) -> Self::Item,
{
let first = self.next()?;
Some(self.fold(first, f))
}
/// 通过重复应用 Reduce 操作,将元素归约为单个元素。
/// 如果闭包返回失败,则失败会立即传播给调用者。
///
/// 此方法的返回类型取决于闭包的返回类型。
/// 如果闭包返回 `Result<Self::Item, E>`,那么这个函数将返回 `Result<Option<Self::Item>, E>`。
/// 如果闭包返回 `Option<Self::Item>`,那么这个函数将返回 `Option<Option<Self::Item>>`。
///
/// 当调用一个空的迭代器时,这个函数将返回 `Some(None)` 或 `Ok(None)` 取决于提供的闭包的类型。
///
/// 对于至少有一个元素的迭代器,这本质上与使用迭代器的第一个元素作为初始累加器值调用 [`try_fold()`] 相同。
///
///
/// [`try_fold()`]: Iterator::try_fold
///
/// # Examples
///
/// 安全地计算一系列数字的总和:
///
/// ```
/// #![feature(iterator_try_reduce)]
///
/// let numbers: Vec<usize> = vec![10, 20, 5, 23, 0];
/// let sum = numbers.into_iter().try_reduce(|x, y| x.checked_add(y));
/// assert_eq!(sum, Some(Some(58)));
/// ```
///
/// 确定什么时候 reduction 短路:
///
/// ```
/// #![feature(iterator_try_reduce)]
///
/// let numbers = vec![1, 2, 3, usize::MAX, 4, 5];
/// let sum = numbers.into_iter().try_reduce(|x, y| x.checked_add(y));
/// assert_eq!(sum, None);
/// ```
///
/// 确定在什么情况下没有 reduction,因为没有元素:
///
/// ```
/// #![feature(iterator_try_reduce)]
///
/// let numbers: Vec<usize> = Vec::new();
/// let sum = numbers.into_iter().try_reduce(|x, y| x.checked_add(y));
/// assert_eq!(sum, Some(None));
/// ```
///
/// 使用 [`Result`] 而不是 [`Option`]:
///
/// ```
/// #![feature(iterator_try_reduce)]
///
/// let numbers = vec!["1", "2", "3", "4", "5"];
/// let max: Result<Option<_>, <usize as std::str::FromStr>::Err> =
/// numbers.into_iter().try_reduce(|x, y| {
/// if x.parse::<usize>()? > y.parse::<usize>()? { Ok(x) } else { Ok(y) }
/// });
/// assert_eq!(max, Ok(Some("5")));
/// ```
///
///
#[inline]
#[unstable(feature = "iterator_try_reduce", reason = "new API", issue = "87053")]
#[rustc_do_not_const_check]
fn try_reduce<F, R>(&mut self, f: F) -> ChangeOutputType<R, Option<R::Output>>
where
Self: Sized,
F: FnMut(Self::Item, Self::Item) -> R,
R: Try<Output = Self::Item>,
R::Residual: Residual<Option<Self::Item>>,
{
let first = match self.next() {
Some(i) => i,
None => return Try::from_output(None),
};
match self.try_fold(first, f).branch() {
ControlFlow::Break(r) => FromResidual::from_residual(r),
ControlFlow::Continue(i) => Try::from_output(Some(i)),
}
}
/// 测试迭代器的每个元素是否与谓词匹配。
///
/// `all()` 接受一个返回 `true` 或 `false` 的闭包。它将这个闭包应用于迭代器的每个元素,如果它们都返回 `true`,那么 `all()` 也返回。
/// 如果它们中的任何一个返回 `false`,则返回 `false`。
///
/// `all()` 是短路的; 换句话说,它一旦找到 `false` 就会停止处理,因为无论发生什么,结果也将是 `false`。
///
///
/// 空的迭代器将返回 `true`。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
///
/// assert!(a.iter().all(|&x| x > 0));
///
/// assert!(!a.iter().all(|&x| x > 2));
/// ```
///
/// 在第一个 `false` 处停止:
///
/// ```
/// let a = [1, 2, 3];
///
/// let mut iter = a.iter();
///
/// assert!(!iter.all(|&x| x != 2));
///
/// // 我们仍然可以使用 `iter`,因为还有更多元素。
/// assert_eq!(iter.next(), Some(&3));
/// ```
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn all<F>(&mut self, f: F) -> bool
where
Self: Sized,
F: FnMut(Self::Item) -> bool,
{
#[inline]
fn check<T>(mut f: impl FnMut(T) -> bool) -> impl FnMut((), T) -> ControlFlow<()> {
move |(), x| {
if f(x) { ControlFlow::Continue(()) } else { ControlFlow::Break(()) }
}
}
self.try_fold((), check(f)) == ControlFlow::Continue(())
}
/// 测试迭代器的任何元素是否与谓词匹配。
///
/// `any()` 接受一个返回 `true` 或 `false` 的闭包。它将这个闭包应用于迭代器的每个元素,如果它们中的任何一个返回 `true`,那么 `any()` 也是如此。
/// 如果它们都返回 `false`,则返回 `false`。
///
/// `any()` 是短路的; 换句话说,它一旦找到 `true` 就会停止处理,因为无论发生什么,结果也将是 `true`。
///
///
/// 空的迭代器将返回 `false`。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
///
/// assert!(a.iter().any(|&x| x > 0));
///
/// assert!(!a.iter().any(|&x| x > 5));
/// ```
///
/// 在第一个 `true` 处停止:
///
/// ```
/// let a = [1, 2, 3];
///
/// let mut iter = a.iter();
///
/// assert!(iter.any(|&x| x != 2));
///
/// // 我们仍然可以使用 `iter`,因为还有更多元素。
/// assert_eq!(iter.next(), Some(&2));
/// ```
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn any<F>(&mut self, f: F) -> bool
where
Self: Sized,
F: FnMut(Self::Item) -> bool,
{
#[inline]
fn check<T>(mut f: impl FnMut(T) -> bool) -> impl FnMut((), T) -> ControlFlow<()> {
move |(), x| {
if f(x) { ControlFlow::Break(()) } else { ControlFlow::Continue(()) }
}
}
self.try_fold((), check(f)) == ControlFlow::Break(())
}
/// 搜索满足谓词的迭代器的元素。
///
/// `find()` 接受一个返回 `true` 或 `false` 的闭包。
/// 它将这个闭包应用于迭代器的每个元素,如果其中任何一个返回 `true`,则 `find()` 返回 [`Some(element)`]。
/// 如果它们都返回 `false`,则返回 [`None`]。
///
/// `find()` 是短路的; 换句话说,一旦闭包返回 `true`,它将立即停止处理。
///
/// 由于 `find()` 接受 quot,并且许多迭代器迭代 quot,因此导致参数为双 quot 的情况可能令人困惑。
///
/// 在 `&&x` 的以下示例中,您可以看到这种效果。
///
/// 如果需要元素的索引,请参见 [`position()`]。
///
/// [`Some(element)`]: Some
/// [`position()`]: Iterator::position
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
///
/// assert_eq!(a.iter().find(|&&x| x == 2), Some(&2));
///
/// assert_eq!(a.iter().find(|&&x| x == 5), None);
/// ```
///
/// 在第一个 `true` 处停止:
///
/// ```
/// let a = [1, 2, 3];
///
/// let mut iter = a.iter();
///
/// assert_eq!(iter.find(|&&x| x == 2), Some(&2));
///
/// // 我们仍然可以使用 `iter`,因为还有更多元素。
/// assert_eq!(iter.next(), Some(&3));
/// ```
///
/// 请注意,`iter.find(f)` 等效于 `iter.filter(f).next()`。
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn find<P>(&mut self, predicate: P) -> Option<Self::Item>
where
Self: Sized,
P: FnMut(&Self::Item) -> bool,
{
#[inline]
fn check<T>(mut predicate: impl FnMut(&T) -> bool) -> impl FnMut((), T) -> ControlFlow<T> {
move |(), x| {
if predicate(&x) { ControlFlow::Break(x) } else { ControlFlow::Continue(()) }
}
}
self.try_fold((), check(predicate)).break_value()
}
/// 将函数应用于迭代器的元素,并返回第一个非 None 的结果。
///
///
/// `iter.find_map(f)` 相当于 `iter.filter_map(f).next()`。
///
/// # Examples
///
/// ```
/// let a = ["lol", "NaN", "2", "5"];
///
/// let first_number = a.iter().find_map(|s| s.parse().ok());
///
/// assert_eq!(first_number, Some(2));
/// ```
#[inline]
#[stable(feature = "iterator_find_map", since = "1.30.0")]
#[rustc_do_not_const_check]
fn find_map<B, F>(&mut self, f: F) -> Option<B>
where
Self: Sized,
F: FnMut(Self::Item) -> Option<B>,
{
#[inline]
fn check<T, B>(mut f: impl FnMut(T) -> Option<B>) -> impl FnMut((), T) -> ControlFlow<B> {
move |(), x| match f(x) {
Some(x) => ControlFlow::Break(x),
None => ControlFlow::Continue(()),
}
}
self.try_fold((), check(f)).break_value()
}
/// 将函数应用于迭代器的元素,并返回第一个为 true 的结果或第一个错误。
///
/// 此方法的返回类型取决于闭包的返回类型。
/// 如果您从闭包中返回 `Result<bool, E>`,您将得到一个 `Result<Option<Self::Item>, E>`。
/// 如果您从闭包中返回 `Option<bool>`,您会得到一个 `Option<Option<Self::Item>>`。
///
/// # Examples
///
/// ```
/// #![feature(try_find)]
///
/// let a = ["1", "2", "lol", "NaN", "5"];
///
/// let is_my_num = |s: &str, search: i32| -> Result<bool, std::num::ParseIntError> {
/// Ok(s.parse::<i32>()? == search)
/// };
///
/// let result = a.iter().try_find(|&&s| is_my_num(s, 2));
/// assert_eq!(result, Ok(Some(&"2")));
///
/// let result = a.iter().try_find(|&&s| is_my_num(s, 5));
/// assert!(result.is_err());
/// ```
///
/// 这也支持实现 `Try` 的其他类型,而不仅仅是 `Result`。
///
/// ```
/// #![feature(try_find)]
///
/// use std::num::NonZeroU32;
/// let a = [3, 5, 7, 4, 9, 0, 11];
/// let result = a.iter().try_find(|&&x| NonZeroU32::new(x).map(|y| y.is_power_of_two()));
/// assert_eq!(result, Some(Some(&4)));
/// let result = a.iter().take(3).try_find(|&&x| NonZeroU32::new(x).map(|y| y.is_power_of_two()));
/// assert_eq!(result, Some(None));
/// let result = a.iter().rev().try_find(|&&x| NonZeroU32::new(x).map(|y| y.is_power_of_two()));
/// assert_eq!(result, None);
/// ```
#[inline]
#[unstable(feature = "try_find", reason = "new API", issue = "63178")]
#[rustc_do_not_const_check]
fn try_find<F, R>(&mut self, f: F) -> ChangeOutputType<R, Option<Self::Item>>
where
Self: Sized,
F: FnMut(&Self::Item) -> R,
R: Try<Output = bool>,
R::Residual: Residual<Option<Self::Item>>,
{
#[inline]
fn check<I, V, R>(
mut f: impl FnMut(&I) -> V,
) -> impl FnMut((), I) -> ControlFlow<R::TryType>
where
V: Try<Output = bool, Residual = R>,
R: Residual<Option<I>>,
{
move |(), x| match f(&x).branch() {
ControlFlow::Continue(false) => ControlFlow::Continue(()),
ControlFlow::Continue(true) => ControlFlow::Break(Try::from_output(Some(x))),
ControlFlow::Break(r) => ControlFlow::Break(FromResidual::from_residual(r)),
}
}
match self.try_fold((), check(f)) {
ControlFlow::Break(x) => x,
ControlFlow::Continue(()) => Try::from_output(None),
}
}
/// 在迭代器中搜索元素,并返回其索引。
///
/// `position()` 接受一个返回 `true` 或 `false` 的闭包。
/// 它将这个闭包应用于迭代器的每个元素,如果其中一个返回 `true`,则 `position()` 返回 [`Some(index)`]。
/// 如果它们全部返回 `false`,则返回 [`None`]。
///
/// `position()` 是短路的; 换句话说,它会在找到 `true` 后立即停止处理。
///
/// # 溢出行为
///
/// 该方法无法防止溢出,因此,如果存在多个不匹配的 [`usize::MAX`] 元素,则会产生错误的结果或 panics。
///
/// 如果启用了调试断言,则将保证 panic。
///
/// # Panics
///
/// 如果迭代器具有多个 `usize::MAX` 不匹配元素,则此函数可能为 panic。
///
/// [`Some(index)`]: Some
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
///
/// assert_eq!(a.iter().position(|&x| x == 2), Some(1));
///
/// assert_eq!(a.iter().position(|&x| x == 5), None);
/// ```
///
/// 在第一个 `true` 处停止:
///
/// ```
/// let a = [1, 2, 3, 4];
///
/// let mut iter = a.iter();
///
/// assert_eq!(iter.position(|&x| x >= 2), Some(1));
///
/// // 我们仍然可以使用 `iter`,因为还有更多元素。
/// assert_eq!(iter.next(), Some(&3));
///
/// // 返回的索引取决于迭代器状态
/// assert_eq!(iter.position(|&x| x == 4), Some(0));
///
/// ```
///
///
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn position<P>(&mut self, predicate: P) -> Option<usize>
where
Self: Sized,
P: FnMut(Self::Item) -> bool,
{
#[inline]
fn check<T>(
mut predicate: impl FnMut(T) -> bool,
) -> impl FnMut(usize, T) -> ControlFlow<usize, usize> {
#[rustc_inherit_overflow_checks]
move |i, x| {
if predicate(x) { ControlFlow::Break(i) } else { ControlFlow::Continue(i + 1) }
}
}
self.try_fold(0, check(predicate)).break_value()
}
/// 从右侧搜索迭代器中的元素,并返回其索引。
///
/// `rposition()` 接受一个返回 `true` 或 `false` 的闭包。
/// 将从结束开始将此闭包应用于迭代器的每个元素,如果其中一个返回 `true`,则 `rposition()` 返回 [`Some(index)`]。
///
/// 如果它们全部返回 `false`,则返回 [`None`]。
///
/// `rposition()` 是短路的; 换句话说,它会在找到 `true` 后立即停止处理。
///
/// [`Some(index)`]: Some
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
///
/// assert_eq!(a.iter().rposition(|&x| x == 3), Some(2));
///
/// assert_eq!(a.iter().rposition(|&x| x == 5), None);
/// ```
///
/// 在第一个 `true` 处停止:
///
/// ```
/// let a = [-1, 2, 3, 4];
///
/// let mut iter = a.iter();
///
/// assert_eq!(iter.rposition(|&x| x >= 2), Some(3));
///
/// // 我们仍然可以使用 `iter`,因为还有更多元素。
/// assert_eq!(iter.next(), Some(&-1));
/// ```
///
///
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn rposition<P>(&mut self, predicate: P) -> Option<usize>
where
P: FnMut(Self::Item) -> bool,
Self: Sized + ExactSizeIterator + DoubleEndedIterator,
{
// 这里不需要进行溢出检查,因为 `ExactSizeIterator` 表示元素数量适合 `usize`。
//
#[inline]
fn check<T>(
mut predicate: impl FnMut(T) -> bool,
) -> impl FnMut(usize, T) -> ControlFlow<usize, usize> {
move |i, x| {
let i = i - 1;
if predicate(x) { ControlFlow::Break(i) } else { ControlFlow::Continue(i) }
}
}
let n = self.len();
self.try_rfold(n, check(predicate)).break_value()
}
/// 返回迭代器的最大元素。
///
/// 如果几个元素最大相等,则返回最后一个元素。如果迭代器为空,则返回 [`None`]。
///
/// 请注意,由于 NaN 不可比较,[`f32`]/[`f64`] 没有实现 [`Ord`]。
/// 您可以使用 [`Iterator::reduce`] 解决此问题:
///
/// ```
/// assert_eq!(
/// [2.4, f32::NAN, 1.3]
/// .into_iter()
/// .reduce(f32::max)
/// .unwrap(),
/// 2.4
/// );
/// ```
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
/// let b: Vec<u32> = Vec::new();
///
/// assert_eq!(a.iter().max(), Some(&3));
/// assert_eq!(b.iter().max(), None);
/// ```
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn max(self) -> Option<Self::Item>
where
Self: Sized,
Self::Item: Ord,
{
self.max_by(Ord::cmp)
}
/// 返回迭代器的最小元素。
///
/// 如果几个元素相等地最小,则返回第一个元素。
/// 如果迭代器为空,则返回 [`None`]。
///
/// 请注意,由于 NaN 不可比较,[`f32`]/[`f64`] 没有实现 [`Ord`]。您可以使用 [`Iterator::reduce`] 解决此问题:
///
/// ```
/// assert_eq!(
/// [2.4, f32::NAN, 1.3]
/// .into_iter()
/// .reduce(f32::min)
/// .unwrap(),
/// 1.3
/// );
/// ```
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
/// let b: Vec<u32> = Vec::new();
///
/// assert_eq!(a.iter().min(), Some(&1));
/// assert_eq!(b.iter().min(), None);
/// ```
#[inline]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn min(self) -> Option<Self::Item>
where
Self: Sized,
Self::Item: Ord,
{
self.min_by(Ord::cmp)
}
/// 返回给出指定函数最大值的元素。
///
///
/// 如果几个元素最大相等,则返回最后一个元素。
/// 如果迭代器为空,则返回 [`None`]。
///
/// # Examples
///
/// ```
/// let a = [-3_i32, 0, 1, 5, -10];
/// assert_eq!(*a.iter().max_by_key(|x| x.abs()).unwrap(), -10);
/// ```
#[inline]
#[stable(feature = "iter_cmp_by_key", since = "1.6.0")]
#[rustc_do_not_const_check]
fn max_by_key<B: Ord, F>(self, f: F) -> Option<Self::Item>
where
Self: Sized,
F: FnMut(&Self::Item) -> B,
{
#[inline]
fn key<T, B>(mut f: impl FnMut(&T) -> B) -> impl FnMut(T) -> (B, T) {
move |x| (f(&x), x)
}
#[inline]
fn compare<T, B: Ord>((x_p, _): &(B, T), (y_p, _): &(B, T)) -> Ordering {
x_p.cmp(y_p)
}
let (_, x) = self.map(key(f)).max_by(compare)?;
Some(x)
}
/// 返回给出相对于指定比较函数的最大值的元素。
///
///
/// 如果几个元素最大相等,则返回最后一个元素。
/// 如果迭代器为空,则返回 [`None`]。
///
/// # Examples
///
/// ```
/// let a = [-3_i32, 0, 1, 5, -10];
/// assert_eq!(*a.iter().max_by(|x, y| x.cmp(y)).unwrap(), 5);
/// ```
#[inline]
#[stable(feature = "iter_max_by", since = "1.15.0")]
#[rustc_do_not_const_check]
fn max_by<F>(self, compare: F) -> Option<Self::Item>
where
Self: Sized,
F: FnMut(&Self::Item, &Self::Item) -> Ordering,
{
#[inline]
fn fold<T>(mut compare: impl FnMut(&T, &T) -> Ordering) -> impl FnMut(T, T) -> T {
move |x, y| cmp::max_by(x, y, &mut compare)
}
self.reduce(fold(compare))
}
/// 返回给出指定函数中最小值的元素。
///
///
/// 如果几个元素相等地最小,则返回第一个元素。
/// 如果迭代器为空,则返回 [`None`]。
///
/// # Examples
///
/// ```
/// let a = [-3_i32, 0, 1, 5, -10];
/// assert_eq!(*a.iter().min_by_key(|x| x.abs()).unwrap(), 0);
/// ```
#[inline]
#[stable(feature = "iter_cmp_by_key", since = "1.6.0")]
#[rustc_do_not_const_check]
fn min_by_key<B: Ord, F>(self, f: F) -> Option<Self::Item>
where
Self: Sized,
F: FnMut(&Self::Item) -> B,
{
#[inline]
fn key<T, B>(mut f: impl FnMut(&T) -> B) -> impl FnMut(T) -> (B, T) {
move |x| (f(&x), x)
}
#[inline]
fn compare<T, B: Ord>((x_p, _): &(B, T), (y_p, _): &(B, T)) -> Ordering {
x_p.cmp(y_p)
}
let (_, x) = self.map(key(f)).min_by(compare)?;
Some(x)
}
/// 返回给出相对于指定比较函数的最小值的元素。
///
///
/// 如果几个元素相等地最小,则返回第一个元素。
/// 如果迭代器为空,则返回 [`None`]。
///
/// # Examples
///
/// ```
/// let a = [-3_i32, 0, 1, 5, -10];
/// assert_eq!(*a.iter().min_by(|x, y| x.cmp(y)).unwrap(), -10);
/// ```
#[inline]
#[stable(feature = "iter_min_by", since = "1.15.0")]
#[rustc_do_not_const_check]
fn min_by<F>(self, compare: F) -> Option<Self::Item>
where
Self: Sized,
F: FnMut(&Self::Item, &Self::Item) -> Ordering,
{
#[inline]
fn fold<T>(mut compare: impl FnMut(&T, &T) -> Ordering) -> impl FnMut(T, T) -> T {
move |x, y| cmp::min_by(x, y, &mut compare)
}
self.reduce(fold(compare))
}
/// 反转迭代器的方向。
///
/// 通常,迭代器从左到右进行迭代。
/// 使用 `rev()` 之后,迭代器将改为从右向左进行迭代。
///
/// 仅在迭代器具有结束符的情况下才有可能,因此 `rev()` 仅适用于 [`DoubleEndedIterator`]。
///
///
/// # Examples
///
/// ```
/// let a = [1, 2, 3];
///
/// let mut iter = a.iter().rev();
///
/// assert_eq!(iter.next(), Some(&3));
/// assert_eq!(iter.next(), Some(&2));
/// assert_eq!(iter.next(), Some(&1));
///
/// assert_eq!(iter.next(), None);
/// ```
#[inline]
#[doc(alias = "reverse")]
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn rev(self) -> Rev<Self>
where
Self: Sized + DoubleEndedIterator,
{
Rev::new(self)
}
/// 将成对的迭代器转换为一对容器。
///
/// `unzip()` 消耗整个对的迭代器,产生两个集合:一个来自对的左侧元素,一个来自右侧元素。
///
///
/// 从某种意义上说,该函数与 [`zip`] 相反。
///
/// [`zip`]: Iterator::zip
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [(1, 2), (3, 4), (5, 6)];
///
/// let (left, right): (Vec<_>, Vec<_>) = a.iter().cloned().unzip();
///
/// assert_eq!(left, [1, 3, 5]);
/// assert_eq!(right, [2, 4, 6]);
///
/// // 您还可以一次解压缩多个嵌套元组
/// let a = [(1, (2, 3)), (4, (5, 6))];
///
/// let (x, (y, z)): (Vec<_>, (Vec<_>, Vec<_>)) = a.iter().cloned().unzip();
/// assert_eq!(x, [1, 4]);
/// assert_eq!(y, [2, 5]);
/// assert_eq!(z, [3, 6]);
/// ```
///
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn unzip<A, B, FromA, FromB>(self) -> (FromA, FromB)
where
FromA: Default + Extend<A>,
FromB: Default + Extend<B>,
Self: Sized + Iterator<Item = (A, B)>,
{
let mut unzipped: (FromA, FromB) = Default::default();
unzipped.extend(self);
unzipped
}
/// 创建一个迭代器,该迭代器将复制其所有元素。
///
/// 当在 `&T` 上具有迭代器,但在 `T` 上需要迭代器时,此功能很有用。
///
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
///
/// let v_copied: Vec<_> = a.iter().copied().collect();
///
/// // copied 与 .map (|&x| x)
/// let v_map: Vec<_> = a.iter().map(|&x| x).collect();
///
/// assert_eq!(v_copied, vec![1, 2, 3]);
/// assert_eq!(v_map, vec![1, 2, 3]);
/// ```
#[stable(feature = "iter_copied", since = "1.36.0")]
#[rustc_do_not_const_check]
fn copied<'a, T: 'a>(self) -> Copied<Self>
where
Self: Sized + Iterator<Item = &'a T>,
T: Copy,
{
Copied::new(self)
}
/// 创建一个迭代器,该迭代器将克隆所有元素。
///
/// 当在 `&T` 上具有迭代器,但在 `T` 上需要迭代器时,此功能很有用。
///
/// 没有任何关于 `clone` 方法实际上会被调用或优化掉的保证。
/// 所以代码不应该依赖于任何一个。
///
/// [`clone`]: Clone::clone
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
///
/// let v_cloned: Vec<_> = a.iter().cloned().collect();
///
/// // 对于整数,cloneed 与 .map(|&x| x) 相同
/// let v_map: Vec<_> = a.iter().map(|&x| x).collect();
///
/// assert_eq!(v_cloned, vec![1, 2, 3]);
/// assert_eq!(v_map, vec![1, 2, 3]);
/// ```
///
/// 要获得最佳性能,请尝试延迟克隆:
///
/// ```
/// let a = [vec![0_u8, 1, 2], vec![3, 4], vec![23]];
/// // 不要这样做:
/// let slower: Vec<_> = a.iter().cloned().filter(|s| s.len() == 1).collect();
/// assert_eq!(&[vec![23]], &slower[..]);
/// // 而是调用 `cloned` 延迟
/// let faster: Vec<_> = a.iter().filter(|s| s.len() == 1).cloned().collect();
/// assert_eq!(&[vec![23]], &faster[..]);
/// ```
///
///
#[stable(feature = "rust1", since = "1.0.0")]
#[rustc_do_not_const_check]
fn cloned<'a, T: 'a>(self) -> Cloned<Self>
where
Self: Sized + Iterator<Item = &'a T>,
T: Clone,
{
Cloned::new(self)
}
/// 不断重复的迭代器。
///
/// 迭代器不会在 [`None`] 处停止,而是会从头开始重新启动。再次迭代后,它将再次从头开始。然后再次。
/// 然后再次。
/// Forever.
/// 请注意,如果原始迭代器为空,则生成的迭代器也将为空。
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
///
/// let mut it = a.iter().cycle();
///
/// assert_eq!(it.next(), Some(&1));
/// assert_eq!(it.next(), Some(&2));
/// assert_eq!(it.next(), Some(&3));
/// assert_eq!(it.next(), Some(&1));
/// assert_eq!(it.next(), Some(&2));
/// assert_eq!(it.next(), Some(&3));
/// assert_eq!(it.next(), Some(&1));
/// ```
#[stable(feature = "rust1", since = "1.0.0")]
#[inline]
#[rustc_do_not_const_check]
fn cycle(self) -> Cycle<Self>
where
Self: Sized + Clone,
{
Cycle::new(self)
}
/// 一次返回迭代器的 `N` 个元素的迭代器。
///
/// 块并不重叠。
/// 如果 `N` 不除以迭代器的长度,那么最后的 `N-1` 元素将被省略,并且可以从迭代器的 [`.into_remainder()`][ArrayChunks::into_remainder] 函数中检索。
///
///
/// # Panics
///
/// 如果 `N` 是 panic 0.
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// #![feature(iter_array_chunks)]
///
/// let mut iter = "lorem".chars().array_chunks();
/// assert_eq!(iter.next(), Some(['l', 'o']));
/// assert_eq!(iter.next(), Some(['r', 'e']));
/// assert_eq!(iter.next(), None);
/// assert_eq!(iter.into_remainder().unwrap().as_slice(), &['m']);
/// ```
///
/// ```
/// #![feature(iter_array_chunks)]
///
/// let data = [1, 1, 2, -2, 6, 0, 3, 1];
/// // ^-----^ ^------^
/// for [x, y, z] in data.iter().array_chunks() {
/// assert_eq!(x + y + z, 4);
/// }
/// ```
///
#[track_caller]
#[unstable(feature = "iter_array_chunks", reason = "recently added", issue = "100450")]
#[rustc_do_not_const_check]
fn array_chunks<const N: usize>(self) -> ArrayChunks<Self, N>
where
Self: Sized,
{
ArrayChunks::new(self)
}
/// 对迭代器的元素求和。
///
/// 获取每个元素,将它们添加在一起,然后返回结果。
///
/// 空的迭代器将返回该类型的零值。
///
/// `sum()` 可用于对任何实现 [`Sum`][`core::iter::Sum`] 的类型求和,包括 [`Option`][`Option::sum`] 和 [`Result`][`Result::sum`]。
///
/// # Panics
///
/// 当调用 `sum()` 并返回原始整数类型时,如果计算溢出并且启用了调试断言,则此方法将为 panic。
///
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// let a = [1, 2, 3];
/// let sum: i32 = a.iter().sum();
///
/// assert_eq!(sum, 6);
/// ```
///
///
#[stable(feature = "iter_arith", since = "1.11.0")]
#[rustc_do_not_const_check]
fn sum<S>(self) -> S
where
Self: Sized,
S: Sum<Self::Item>,
{
Sum::sum(self)
}
/// 遍历整个迭代器,将所有元素相乘
///
/// 空的迭代器将返回该类型的一个值。
///
/// `product()` 可用于乘以任何实现 [`Product`][`core::iter::Product`] 的类型,包括 [`Option`][`Option::product`] 和 [`Result`][`Result::product`]。
///
///
/// # Panics
///
/// 当调用 `product()` 并返回原始整数类型时,如果计算溢出并且启用了调试断言,则方法将为 panic。
///
/// # Examples
///
/// ```
/// fn factorial(n: u32) -> u32 {
/// (1..=n).product()
/// }
/// assert_eq!(factorial(0), 1);
/// assert_eq!(factorial(1), 1);
/// assert_eq!(factorial(5), 120);
/// ```
///
///
#[stable(feature = "iter_arith", since = "1.11.0")]
#[rustc_do_not_const_check]
fn product<P>(self) -> P
where
Self: Sized,
P: Product<Self::Item>,
{
Product::product(self)
}
/// [字典顺序](Ord#lexicographical-comparison) 将这个 [`Iterator`] 的元素与另一个的元素进行比较。
///
///
/// # Examples
///
/// ```
/// use std::cmp::Ordering;
///
/// assert_eq!([1].iter().cmp([1].iter()), Ordering::Equal);
/// assert_eq!([1].iter().cmp([1, 2].iter()), Ordering::Less);
/// assert_eq!([1, 2].iter().cmp([1].iter()), Ordering::Greater);
/// ```
#[stable(feature = "iter_order", since = "1.5.0")]
#[rustc_do_not_const_check]
fn cmp<I>(self, other: I) -> Ordering
where
I: IntoIterator<Item = Self::Item>,
Self::Item: Ord,
Self: Sized,
{
self.cmp_by(other, |x, y| x.cmp(&y))
}
/// [字典顺序](Ord#lexicographical-comparison) 根据指定的比较函数将这个 [`Iterator`] 的元素与另一个 [`Iterator`] 的元素进行比较。
///
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// #![feature(iter_order_by)]
///
/// use std::cmp::Ordering;
///
/// let xs = [1, 2, 3, 4];
/// let ys = [1, 4, 9, 16];
///
/// assert_eq!(xs.iter().cmp_by(&ys, |&x, &y| x.cmp(&y)), Ordering::Less);
/// assert_eq!(xs.iter().cmp_by(&ys, |&x, &y| (x * x).cmp(&y)), Ordering::Equal);
/// assert_eq!(xs.iter().cmp_by(&ys, |&x, &y| (2 * x).cmp(&y)), Ordering::Greater);
/// ```
#[unstable(feature = "iter_order_by", issue = "64295")]
#[rustc_do_not_const_check]
fn cmp_by<I, F>(self, other: I, cmp: F) -> Ordering
where
Self: Sized,
I: IntoIterator,
F: FnMut(Self::Item, I::Item) -> Ordering,
{
#[inline]
fn compare<X, Y, F>(mut cmp: F) -> impl FnMut(X, Y) -> ControlFlow<Ordering>
where
F: FnMut(X, Y) -> Ordering,
{
move |x, y| match cmp(x, y) {
Ordering::Equal => ControlFlow::Continue(()),
non_eq => ControlFlow::Break(non_eq),
}
}
match iter_compare(self, other.into_iter(), compare(cmp)) {
ControlFlow::Continue(ord) => ord,
ControlFlow::Break(ord) => ord,
}
}
/// [Lexicographically](Ord#lexicographical-comparison) 将此 [`Iterator`] 的 [`PartialOrd`] 元素与另一个 [`PartialOrd`] 的元素进行比较。
/// 比较的工作方式类似于短路评估,返回结果而不比较其余元素。
/// 一旦可以确定订单,评估就会停止并返回结果。
///
/// # Examples
///
/// ```
/// use std::cmp::Ordering;
///
/// assert_eq!([1.].iter().partial_cmp([1.].iter()), Some(Ordering::Equal));
/// assert_eq!([1.].iter().partial_cmp([1., 2.].iter()), Some(Ordering::Less));
/// assert_eq!([1., 2.].iter().partial_cmp([1.].iter()), Some(Ordering::Greater));
/// ```
///
/// 对于浮点数,NaN 没有顺序关系,比较时结果为 `None`:
///
/// ```
/// assert_eq!([f64::NAN].iter().partial_cmp([1.].iter()), None);
/// ```
///
/// 结果由评价顺序决定。
///
/// ```
/// use std::cmp::Ordering;
///
/// assert_eq!([1.0, f64::NAN].iter().partial_cmp([2.0, f64::NAN].iter()), Some(Ordering::Less));
/// assert_eq!([2.0, f64::NAN].iter().partial_cmp([1.0, f64::NAN].iter()), Some(Ordering::Greater));
/// assert_eq!([f64::NAN, 1.0].iter().partial_cmp([f64::NAN, 2.0].iter()), None);
/// ```
///
///
///
#[stable(feature = "iter_order", since = "1.5.0")]
#[rustc_do_not_const_check]
fn partial_cmp<I>(self, other: I) -> Option<Ordering>
where
I: IntoIterator,
Self::Item: PartialOrd<I::Item>,
Self: Sized,
{
self.partial_cmp_by(other, |x, y| x.partial_cmp(&y))
}
/// [字典顺序](Ord#lexicographical-comparison) 根据指定的比较函数将这个 [`Iterator`] 的元素与另一个 [`Iterator`] 的元素进行比较。
///
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// #![feature(iter_order_by)]
///
/// use std::cmp::Ordering;
///
/// let xs = [1.0, 2.0, 3.0, 4.0];
/// let ys = [1.0, 4.0, 9.0, 16.0];
///
/// assert_eq!(
/// xs.iter().partial_cmp_by(&ys, |&x, &y| x.partial_cmp(&y)),
/// Some(Ordering::Less)
/// );
/// assert_eq!(
/// xs.iter().partial_cmp_by(&ys, |&x, &y| (x * x).partial_cmp(&y)),
/// Some(Ordering::Equal)
/// );
/// assert_eq!(
/// xs.iter().partial_cmp_by(&ys, |&x, &y| (2.0 * x).partial_cmp(&y)),
/// Some(Ordering::Greater)
/// );
/// ```
#[unstable(feature = "iter_order_by", issue = "64295")]
#[rustc_do_not_const_check]
fn partial_cmp_by<I, F>(self, other: I, partial_cmp: F) -> Option<Ordering>
where
Self: Sized,
I: IntoIterator,
F: FnMut(Self::Item, I::Item) -> Option<Ordering>,
{
#[inline]
fn compare<X, Y, F>(mut partial_cmp: F) -> impl FnMut(X, Y) -> ControlFlow<Option<Ordering>>
where
F: FnMut(X, Y) -> Option<Ordering>,
{
move |x, y| match partial_cmp(x, y) {
Some(Ordering::Equal) => ControlFlow::Continue(()),
non_eq => ControlFlow::Break(non_eq),
}
}
match iter_compare(self, other.into_iter(), compare(partial_cmp)) {
ControlFlow::Continue(ord) => Some(ord),
ControlFlow::Break(ord) => ord,
}
}
/// 确定此 [`Iterator`] 的元素是否与另一个元素相同。
///
///
/// # Examples
///
/// ```
/// assert_eq!([1].iter().eq([1].iter()), true);
/// assert_eq!([1].iter().eq([1, 2].iter()), false);
/// ```
#[stable(feature = "iter_order", since = "1.5.0")]
#[rustc_do_not_const_check]
fn eq<I>(self, other: I) -> bool
where
I: IntoIterator,
Self::Item: PartialEq<I::Item>,
Self: Sized,
{
self.eq_by(other, |x, y| x == y)
}
/// 关于指定的相等函数,确定 [`Iterator`] 的元素是否与另一个元素相等。
///
///
/// # Examples
///
/// 基本用法:
///
/// ```
/// #![feature(iter_order_by)]
///
/// let xs = [1, 2, 3, 4];
/// let ys = [1, 4, 9, 16];
///
/// assert!(xs.iter().eq_by(&ys, |&x, &y| x * x == y));
/// ```
#[unstable(feature = "iter_order_by", issue = "64295")]
#[rustc_do_not_const_check]
fn eq_by<I, F>(self, other: I, eq: F) -> bool
where
Self: Sized,
I: IntoIterator,
F: FnMut(Self::Item, I::Item) -> bool,
{
#[inline]
fn compare<X, Y, F>(mut eq: F) -> impl FnMut(X, Y) -> ControlFlow<()>
where
F: FnMut(X, Y) -> bool,
{
move |x, y| {
if eq(x, y) { ControlFlow::Continue(()) } else { ControlFlow::Break(()) }
}
}
match iter_compare(self, other.into_iter(), compare(eq)) {
ControlFlow::Continue(ord) => ord == Ordering::Equal,
ControlFlow::Break(()) => false,
}
}
/// 确定此 [`Iterator`] 的元素是否不等于另一个的元素。
///
///
/// # Examples
///
/// ```
/// assert_eq!([1].iter().ne([1].iter()), false);
/// assert_eq!([1].iter().ne([1, 2].iter()), true);
/// ```
#[stable(feature = "iter_order", since = "1.5.0")]
#[rustc_do_not_const_check]
fn ne<I>(self, other: I) -> bool
where
I: IntoIterator,
Self::Item: PartialEq<I::Item>,
Self: Sized,
{
!self.eq(other)
}
/// 确定此 [`Iterator`] 的元素是否比另一个元素少 [按字典顺序](Ord#lexicographical-comparison)。
///
///
/// # Examples
///
/// ```
/// assert_eq!([1].iter().lt([1].iter()), false);
/// assert_eq!([1].iter().lt([1, 2].iter()), true);
/// assert_eq!([1, 2].iter().lt([1].iter()), false);
/// assert_eq!([1, 2].iter().lt([1, 2].iter()), false);
/// ```
#[stable(feature = "iter_order", since = "1.5.0")]
#[rustc_do_not_const_check]
fn lt<I>(self, other: I) -> bool
where
I: IntoIterator,
Self::Item: PartialOrd<I::Item>,
Self: Sized,
{
self.partial_cmp(other) == Some(Ordering::Less)
}
/// 确定此 [`Iterator`] 的元素是否 [按字典顺序](Ord#lexicographical-comparison) 小于或等于另一个元素。
///
///
/// # Examples
///
/// ```
/// assert_eq!([1].iter().le([1].iter()), true);
/// assert_eq!([1].iter().le([1, 2].iter()), true);
/// assert_eq!([1, 2].iter().le([1].iter()), false);
/// assert_eq!([1, 2].iter().le([1, 2].iter()), true);
/// ```
#[stable(feature = "iter_order", since = "1.5.0")]
#[rustc_do_not_const_check]
fn le<I>(self, other: I) -> bool
where
I: IntoIterator,
Self::Item: PartialOrd<I::Item>,
Self: Sized,
{
matches!(self.partial_cmp(other), Some(Ordering::Less | Ordering::Equal))
}
/// 确定此 [`Iterator`] 的元素是否大于另一个元素的 [按字典顺序](Ord#lexicographical-comparison)。
///
///
/// # Examples
///
/// ```
/// assert_eq!([1].iter().gt([1].iter()), false);
/// assert_eq!([1].iter().gt([1, 2].iter()), false);
/// assert_eq!([1, 2].iter().gt([1].iter()), true);
/// assert_eq!([1, 2].iter().gt([1, 2].iter()), false);
/// ```
#[stable(feature = "iter_order", since = "1.5.0")]
#[rustc_do_not_const_check]
fn gt<I>(self, other: I) -> bool
where
I: IntoIterator,
Self::Item: PartialOrd<I::Item>,
Self: Sized,
{
self.partial_cmp(other) == Some(Ordering::Greater)
}
/// 确定此 [`Iterator`] 的元素是否 [按字典顺序](Ord#lexicographical-comparison) 大于或等于另一个元素。
///
///
/// # Examples
///
/// ```
/// assert_eq!([1].iter().ge([1].iter()), true);
/// assert_eq!([1].iter().ge([1, 2].iter()), false);
/// assert_eq!([1, 2].iter().ge([1].iter()), true);
/// assert_eq!([1, 2].iter().ge([1, 2].iter()), true);
/// ```
#[stable(feature = "iter_order", since = "1.5.0")]
#[rustc_do_not_const_check]
fn ge<I>(self, other: I) -> bool
where
I: IntoIterator,
Self::Item: PartialOrd<I::Item>,
Self: Sized,
{
matches!(self.partial_cmp(other), Some(Ordering::Greater | Ordering::Equal))
}
/// 检查此迭代器的元素是否已排序。
///
/// 也就是说,对于每个元素 `a` 及其后续元素 `b`,`a <= b` 必须成立。如果迭代器的结果恰好为零或一个元素,则返回 `true`。
///
/// 请注意,如果 `Self::Item` 仅是 `PartialOrd`,而不是 `Ord`,则上述定义意味着,如果任何两个连续的项都不具有可比性,则此函数将返回 `false`。
///
///
/// # Examples
///
/// ```
/// #![feature(is_sorted)]
///
/// assert!([1, 2, 2, 9].iter().is_sorted());
/// assert!(![1, 3, 2, 4].iter().is_sorted());
/// assert!([0].iter().is_sorted());
/// assert!(std::iter::empty::<i32>().is_sorted());
/// assert!(![0.0, 1.0, f32::NAN].iter().is_sorted());
/// ```
///
///
#[inline]
#[unstable(feature = "is_sorted", reason = "new API", issue = "53485")]
#[rustc_do_not_const_check]
fn is_sorted(self) -> bool
where
Self: Sized,
Self::Item: PartialOrd,
{
self.is_sorted_by(PartialOrd::partial_cmp)
}
/// 检查此迭代器的元素是否使用给定的比较器函数进行排序。
///
/// 该函数使用给定的 `compare` 函数来确定两个元素的顺序,而不是使用 `PartialOrd::partial_cmp`。
/// 除此之外,它等效于 [`is_sorted`]。有关更多信息,请参见其文档。
///
/// # Examples
///
/// ```
/// #![feature(is_sorted)]
///
/// assert!([1, 2, 2, 9].iter().is_sorted_by(|a, b| a.partial_cmp(b)));
/// assert!(![1, 3, 2, 4].iter().is_sorted_by(|a, b| a.partial_cmp(b)));
/// assert!([0].iter().is_sorted_by(|a, b| a.partial_cmp(b)));
/// assert!(std::iter::empty::<i32>().is_sorted_by(|a, b| a.partial_cmp(b)));
/// assert!(![0.0, 1.0, f32::NAN].iter().is_sorted_by(|a, b| a.partial_cmp(b)));
/// ```
///
/// [`is_sorted`]: Iterator::is_sorted
///
#[unstable(feature = "is_sorted", reason = "new API", issue = "53485")]
#[rustc_do_not_const_check]
fn is_sorted_by<F>(mut self, compare: F) -> bool
where
Self: Sized,
F: FnMut(&Self::Item, &Self::Item) -> Option<Ordering>,
{
#[inline]
fn check<'a, T>(
last: &'a mut T,
mut compare: impl FnMut(&T, &T) -> Option<Ordering> + 'a,
) -> impl FnMut(T) -> bool + 'a {
move |curr| {
if let Some(Ordering::Greater) | None = compare(&last, &curr) {
return false;
}
*last = curr;
true
}
}
let mut last = match self.next() {
Some(e) => e,
None => return true,
};
self.all(check(&mut last, compare))
}
/// 检查此迭代器的元素是否使用给定的键提取函数进行排序。
///
/// 该函数不直接比较迭代器的元素,而是比较元素的键 (由 `f` 确定)。
/// 除此之外,它等效于 [`is_sorted`]。有关更多信息,请参见其文档。
///
/// [`is_sorted`]: Iterator::is_sorted
///
/// # Examples
///
/// ```
/// #![feature(is_sorted)]
///
/// assert!(["c", "bb", "aaa"].iter().is_sorted_by_key(|s| s.len()));
/// assert!(![-2i32, -1, 0, 3].iter().is_sorted_by_key(|n| n.abs()));
/// ```
///
///
#[inline]
#[unstable(feature = "is_sorted", reason = "new API", issue = "53485")]
#[rustc_do_not_const_check]
fn is_sorted_by_key<F, K>(self, f: F) -> bool
where
Self: Sized,
F: FnMut(Self::Item) -> K,
K: PartialOrd,
{
self.map(f).is_sorted()
}
/// 请参见 [TrustedRandomAccess][super::super::TrustedRandomAccess]
// 不寻常的名称是为了避免方法解析中的名称冲突,请参见 #76479。
//
#[inline]
#[doc(hidden)]
#[unstable(feature = "trusted_random_access", issue = "none")]
#[rustc_do_not_const_check]
unsafe fn __iterator_get_unchecked(&mut self, _idx: usize) -> Self::Item
where
Self: TrustedRandomAccessNoCoerce,
{
unreachable!("Always specialized");
}
}
/// 使用给定的函数逐元素比较两个迭代器。
///
/// 如果从函数返回 `ControlFlow::Continue(())`,则比较移动到两个迭代器的下一个元素。返回 `ControlFlow::Break(x)` 会使迭代短路并返回 `ControlFlow::Break(x)`。
///
/// 如果其中一个迭代器用完元素,则返回 `ControlFlow::Continue(ord)`,其中 `ord` 是比较迭代器长度的结果。
///
/// 隔离 ['cmp_by'](Iterator::cmp_by)、['partial_cmp_by'](Iterator::partial_cmp_by) 和 ['eq_by'](Iterator::eq_by) 共享的逻辑。
///
///
///
#[inline]
fn iter_compare<A, B, F, T>(mut a: A, mut b: B, f: F) -> ControlFlow<T, Ordering>
where
A: Iterator,
B: Iterator,
F: FnMut(A::Item, B::Item) -> ControlFlow<T>,
{
#[inline]
fn compare<'a, B, X, T>(
b: &'a mut B,
mut f: impl FnMut(X, B::Item) -> ControlFlow<T> + 'a,
) -> impl FnMut(X) -> ControlFlow<ControlFlow<T, Ordering>> + 'a
where
B: Iterator,
{
move |x| match b.next() {
None => ControlFlow::Break(ControlFlow::Continue(Ordering::Greater)),
Some(y) => f(x, y).map_break(ControlFlow::Break),
}
}
match a.try_for_each(compare(&mut b, f)) {
ControlFlow::Continue(()) => ControlFlow::Continue(match b.next() {
None => Ordering::Equal,
Some(_) => Ordering::Less,
}),
ControlFlow::Break(x) => x,
}
}
#[stable(feature = "rust1", since = "1.0.0")]
impl<I: Iterator + ?Sized> Iterator for &mut I {
type Item = I::Item;
#[inline]
fn next(&mut self) -> Option<I::Item> {
(**self).next()
}
fn size_hint(&self) -> (usize, Option<usize>) {
(**self).size_hint()
}
fn advance_by(&mut self, n: usize) -> Result<(), NonZeroUsize> {
(**self).advance_by(n)
}
fn nth(&mut self, n: usize) -> Option<Self::Item> {
(**self).nth(n)
}
}