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
//! **Note:** the complete list of things **not** available when using `default-features = false`
//! for `#![no_std]` compatibility is as follows:
//! - [`StaticVec::sorted`]
//! - [`StaticVec::into_vec`] (and the corresponding [`Into`] impl)
//! - [`StaticVec::from_vec`] (and the corresponding [`From`] impl)
//! - the implementation of the [`Read`](std::io::Read) trait for [`StaticVec`]
//! - the implementation of the [`BufRead`](std::io::BufRead) trait for [`StaticVec`]
//! - the implementation of the [`io::Write`](std::io::Write) trait for [`StaticVec`]
//! - the implementation of [`From`] for [`StaticString`](crate::string::StaticString) from
//! [`String`](alloc::string::String)
//! - the implementations of [`PartialEq`] and [`PartialOrd`] against
//! [`String`](alloc::string::String) for [`StaticString`](crate::string::StaticString)
//! - the implementation of [`Error`](std::error::Error) for [`StringError`]
//! - the `bounds_to_string` function unique to this crate and implemented by several of the
//! iterators in it
#![no_std]
#![allow(
// Clippy wants every single instance of the word "StaticVec" to be in syntax-highlight
// backticks, which IMO looks way too "noisy" when actually rendered.
clippy::doc_markdown,
// Clippy thinks inline always is a bad idea even for the most simple of one-liners, so
// IMO it's just not a particularly helpful lint.
clippy::inline_always,
// The "if-let" syntax Clippy recommends as an alternative to "match" in this lint is
// generally way less readable IMO.
clippy::match_bool,
// Without this, every single use of const generics is warned against.
incomplete_features
)]
#![feature(
adt_const_params,
const_assume,
const_eval_select,
const_fn_floating_point_arithmetic,
const_maybe_uninit_array_assume_init,
const_maybe_uninit_as_mut_ptr,
const_maybe_uninit_assume_init,
const_maybe_uninit_assume_init_read,
const_maybe_uninit_uninit_array,
const_maybe_uninit_zeroed,
const_mut_refs,
const_precise_live_drops,
const_ptr_is_null,
const_ptr_read,
const_ptr_write,
// this should be called `const_interior_mutability` IMO
const_refs_to_cell,
const_replace,
const_slice_from_raw_parts_mut,
const_swap,
const_trait_impl,
core_intrinsics,
doc_cfg,
exact_size_is_empty,
generic_const_exprs,
inline_const,
maybe_uninit_array_assume_init,
maybe_uninit_uninit_array,
pattern,
slice_partition_dedup,
specialization,
trusted_len,
trusted_random_access
)]
#![cfg_attr(feature = "std", feature(read_buf))]
use core::cmp::{Ord, PartialEq};
use core::intrinsics::assume;
use core::marker::PhantomData;
use core::mem::{self, size_of, MaybeUninit};
use core::ops::{
Add, Bound::Excluded, Bound::Included, Bound::Unbounded, Div, Mul, RangeBounds, Sub,
};
use core::ptr;
use core::slice::{from_raw_parts, from_raw_parts_mut};
pub use crate::errors::{CapacityError, PushCapacityError};
pub use crate::heap::{
StaticHeap, StaticHeapDrainSorted, StaticHeapIntoIterSorted, StaticHeapPeekMut,
};
pub use crate::iterators::{
StaticVecDrain, StaticVecIntoIter, StaticVecIterConst, StaticVecIterMut, StaticVecSplice,
};
pub use crate::string::{StaticString, StringError};
use crate::utils::{const_min, quicksort_internal, reverse_copy, zst_ptr_add, zst_ptr_add_mut};
#[cfg(any(feature = "std", rustdoc))]
extern crate alloc;
#[cfg(any(feature = "std", rustdoc))]
use alloc::vec::Vec;
#[cfg(feature = "std")]
extern crate std;
mod errors;
mod heap;
mod iterators;
#[macro_use]
mod macros;
mod string;
mod trait_impls;
#[doc(hidden)]
pub mod utils;
/// A [`Vec`](alloc::vec::Vec)-like struct (mostly directly API-compatible where it can be)
/// implemented with const generics around an array of fixed `N` capacity.
///
/// Please note that while `rustdoc` does currently correctly render inherent `const fn` method
/// signatures, the same is not true of `const` trait implementation method signatures, so at this
/// time it's recommended that you refer directly to the source code of this crate if unsure of
/// whether a given trait has been implemented as `const` in conjunction with the `const_trait_impl`
/// feature.
pub struct StaticVec<T, const N: usize> {
// We create this field in an uninitialized state, and write to it element-wise as needed via
// pointer methods. At no time should the regular `assume_init` function *ever* be called through
// it unless an abundantly obviously-not-UB reason is present or a clear explanation is provided
// in comments. At this time, we only use `assume_init_read` and `assume_init_mut` (soundly, and
// for good reasons) in about two places total.
data: MaybeUninit<[T; N]>,
// The constant `N` parameter (and thus the total span of `data`) represent capacity for us,
// while the field below represents, as its name suggests, the current length of a StaticVec
// (that is, the current number of "live" elements) just as is the case for a regular `Vec`.
length: usize,
}
impl<T, const N: usize> StaticVec<T, N> {
/// Returns a new StaticVec instance.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticVec;
/// let v = StaticVec::<i32, 4>::new();
/// assert_eq!(v.len(), 0);
/// assert_eq!(v.capacity(), 4);
/// static CV: StaticVec<i32, 4> = StaticVec::new();
/// static LEN: usize = CV.len();
/// static CAP: usize = CV.capacity();
/// assert_eq!(LEN, 0);
/// assert_eq!(CAP, 4);
/// ```
#[inline(always)]
pub const fn new() -> Self {
Self {
data: Self::new_data_uninit(),
length: 0,
}
}
/// Returns a new StaticVec instance filled with the contents, if any, of a slice reference,
/// which can be either `&mut` or `&` as if it is `&mut` it will implicitly coerce to `&`.
/// If the slice has a length greater than the StaticVec's declared capacity,
/// any contents after that point are ignored.
/// Locally requires that `T` implements [`Copy`](core::marker::Copy) to avoid soundness issues.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let v = StaticVec::<i32, 8>::new_from_slice(&[1, 2, 3]);
/// assert_eq!(v, [1, 2, 3]);
/// ```
#[inline]
pub const fn new_from_slice(values: &[T]) -> Self
where T: Copy {
let length = const_min(values.len(), N);
Self {
data: {
let mut data = Self::new_data_uninit();
unsafe {
values
.as_ptr()
.copy_to_nonoverlapping(Self::first_ptr_mut(&mut data), length);
data
}
},
length,
}
}
/// Returns a new StaticVec instance filled with the contents, if any, of an array.
/// If the array has a length greater than the StaticVec's declared capacity,
/// any contents after that point are ignored.
///
/// The `N2` parameter does not need to be provided explicitly, and can be inferred from the array
/// itself.
///
/// This function does *not* leak memory, as any ignored extra elements in the source
/// array are explicitly dropped with [`drop_in_place`](core::ptr::drop_in_place) after it is
/// first wrapped in an instance of [`MaybeUninit`](core::mem::MaybeUninit) to inhibit the
/// automatic calling of any destructors its contents may have.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticVec;
/// // Same input length as the declared capacity:
/// let v = StaticVec::<i32, 3>::new_from_array([1, 2, 3]);
/// assert_eq!(v, [1, 2, 3]);
/// // Truncated to fit the declared capacity:
/// let v2 = StaticVec::<i32, 3>::new_from_array([1, 2, 3, 4, 5, 6]);
/// assert_eq!(v2, [1, 2, 3]);
/// ```
/// Note that StaticVec also implements [`From`](core::convert::From) for both slices and
/// fixed-size arrays (as well as several other types), which may prove more ergonomic in some
/// cases as it allows for a greater degree of type inference:
/// ```
/// # #![feature(box_syntax)]
/// # use staticvec::StaticVec;
/// // The StaticVec on the next line is inferred to be of type `StaticVec<&'static str, 4>`.
/// let v = StaticVec::from(["A", "B", "C", "D"]);
/// assert_eq!(v, ["A", "B", "C", "D"]);
/// ```
/// You can essentially use [`From`](core::convert::From) in the vast majority of scenarios
/// where *either* [`new_from_slice`](crate::StaticVec::new_from_slice) or
/// [`new_from_array`](crate::StaticVec::new_from_array) would be accepted by the compiler,
/// and expect it to "just work" like the appropriate one of the two on a contextual basis.
/// For example, the two "extra" instances of [`Box`](std::boxed::Box) on the next line will
/// be correctly dropped just as they would be when calling
/// [`new_from_array`](crate::StaticVec::new_from_array).
/// ```
/// # #![feature(box_syntax)]
/// # use staticvec::StaticVec;
/// let v2 = StaticVec::<Box<i32>, 2>::from([box 1, box 2, box 3, box 4]);
/// assert_eq!(v2, [box 1, box 2]);
/// ```
#[inline]
pub fn new_from_array<const N2: usize>(values: [T; N2]) -> Self {
if N == N2 {
Self::from(values)
} else {
Self {
data: {
unsafe {
let mut data = Self::new_data_uninit();
values
.as_ptr()
.copy_to_nonoverlapping(Self::first_ptr_mut(&mut data), N2.min(N));
// Wrap the values in a MaybeUninit to inhibit their destructors (if any),
// then manually drop any excess ones. From the assembly output I've looked
// at, the compiler interprets this whole sequence in a way that doesn't result
// in any excess copying, so there should be no performance concerns for larger
// input arrays.
let mut forgotten = MaybeUninit::new(values);
ptr::drop_in_place(forgotten.assume_init_mut().get_unchecked_mut(N2.min(N)..N2));
data
}
},
length: N2.min(N),
}
}
}
/// A version of [`new_from_array`](crate::StaticVec::new_from_array) specifically designed
/// for use as a `const fn` constructor (although it can of course be used in non-const contexts
/// as well.)
///
/// Being `const` necessitates that this function can only accept arrays with a length
/// exactly equal to the declared capacity of the resulting StaticVec, so if you do need
/// flexibility with regards to input lengths it's recommended that you use
/// [`new_from_array`](crate::StaticVec::new_from_array) or the [`From`](core::convert::From)
/// implementations instead.
///
/// Note that both forms of the [`staticvec!`] macro are implemented using
/// [`new_from_const_array`](crate::StaticVec::new_from_const_array), so you may also prefer
/// to use them instead of it directly.
///
/// # Example usage:
/// ```
/// # use staticvec::{staticvec, StaticVec};
/// const v: StaticVec<i32, 4> = StaticVec::new_from_const_array([1, 2, 3, 4]);
/// assert_eq!(v, staticvec![1, 2, 3, 4]);
/// ```
#[inline(always)]
pub const fn new_from_const_array(values: [T; N]) -> Self {
Self {
data: MaybeUninit::new(values),
length: N,
}
}
/// Returns the current length of the StaticVec. Just as for a normal [`Vec`](alloc::vec::Vec),
/// this means the number of elements that have been added to it with
/// [`push`](crate::StaticVec::push), [`insert`](crate::StaticVec::insert), etc. except in the
/// case that it has been set directly with the unsafe [`set_len`](crate::StaticVec::set_len)
/// function.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// assert_eq!(staticvec![1].len(), 1);
/// ```
#[inline(always)]
pub const fn len(&self) -> usize {
self.length
}
/// Returns the total capacity of the StaticVec.
/// This is always equivalent to the generic `N` parameter it was declared with, which determines
/// the fixed size of the backing array.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// assert_eq!(StaticVec::<usize, 800>::new().capacity(), 800);
/// ```
#[inline(always)]
pub const fn capacity(&self) -> usize {
N
}
/// Does the same thing as [`capacity`](crate::StaticVec::capacity), but as an associated function
/// rather than a method.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// assert_eq!(StaticVec::<f64, 12>::cap(), 12)
/// ```
#[inline(always)]
pub const fn cap() -> usize {
N
}
/// Serves the same purpose as [`capacity`](crate::StaticVec::capacity), but as an associated
/// constant rather than a method.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// assert_eq!(StaticVec::<f64, 12>::CAPACITY, 12)
/// ```
pub const CAPACITY: usize = N;
/// Returns the remaining capacity (which is to say, `self.capacity() - self.len()`) of the
/// StaticVec.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut vec = StaticVec::<i32, 100>::new();
/// vec.push(1);
/// assert_eq!(vec.remaining_capacity(), 99);
/// ```
#[inline(always)]
pub const fn remaining_capacity(&self) -> usize {
N - self.length
}
/// Returns the total size of the inhabited part of the StaticVec (which may be zero if it has a
/// length of zero or contains ZSTs) in bytes. Specifically, the return value of this function
/// amounts to a calculation of `size_of::<T>() * self.len()`.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let x = StaticVec::<u8, 8>::from([1, 2, 3, 4, 5, 6, 7, 8]);
/// assert_eq!(x.size_in_bytes(), 8);
/// let y = StaticVec::<u16, 8>::from([1, 2, 3, 4, 5, 6, 7, 8]);
/// assert_eq!(y.size_in_bytes(), 16);
/// let z = StaticVec::<u32, 8>::from([1, 2, 3, 4, 5, 6, 7, 8]);
/// assert_eq!(z.size_in_bytes(), 32);
/// let w = StaticVec::<u64, 8>::from([1, 2, 3, 4, 5, 6, 7, 8]);
/// assert_eq!(w.size_in_bytes(), 64);
/// ```
#[inline(always)]
pub const fn size_in_bytes(&self) -> usize {
size_of::<T>() * self.length
}
/// Directly sets the length field of the StaticVec to `new_len`. Useful if you intend
/// to write to it solely element-wise, but marked unsafe due to how it creates
/// the potential for reading from uninitialized memory later on.
///
/// # Safety
///
/// It is up to the caller to ensure that `new_len` is less than or equal to the StaticVec's
/// constant `N` parameter, and that the range of elements covered by a length of `new_len` is
/// actually initialized. Failure to do so will almost certainly result in undefined behavior.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut vec = StaticVec::<i32, 12>::new();
/// let data = staticvec![1, 2, 3, 4];
/// unsafe {
/// data.as_ptr().copy_to_nonoverlapping(vec.as_mut_ptr(), 4);
/// vec.set_len(4);
/// }
/// assert_eq!(vec.len(), 4);
/// assert_eq!(vec.remaining_capacity(), 8);
/// assert_eq!(vec, data);
/// ```
#[inline(always)]
pub const unsafe fn set_len(&mut self, new_len: usize) {
// Most of the `unsafe` functions in this crate that are heavily used internally
// have debug-build-only assertions where it's useful.
/*
// The formatted assertion macros are not const-compatible yet.
debug_assert!(
new_len <= N,
"In `StaticVec::set_len`, provided length {} exceeds the maximum capacity of {}!",
new_len,
N
);
*/
debug_assert!(
new_len <= N,
"A `new_len` greater than `N` was passed to `StaticVec::set_len`!"
);
self.length = new_len;
}
/// Returns true if the current length of the StaticVec is 0.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// assert!(StaticVec::<i32, 4>::new().is_empty());
/// ```
#[inline(always)]
pub const fn is_empty(&self) -> bool {
self.length == 0
}
/// Returns true if the current length of the StaticVec is greater than 0.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// assert!(staticvec![staticvec![1, 1], staticvec![2, 2]].is_not_empty());
/// ```
// Clippy wants `!is_empty()` for this, but I prefer it as-is. My question is though, does it
// actually know that we have an applicable `is_empty()` function, or is it just guessing? I'm not
// sure.
#[allow(clippy::len_zero)]
#[inline(always)]
pub const fn is_not_empty(&self) -> bool {
self.length > 0
}
/// Returns true if the current length of the StaticVec is equal to its capacity.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// assert!(StaticVec::<i32, 4>::filled_with(|| 2).is_full());
/// ```
#[inline(always)]
pub const fn is_full(&self) -> bool {
self.length == N
}
/// Returns true if the current length of the StaticVec is less than its capacity.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// assert!(StaticVec::<i32, 4>::new().is_not_full());
/// ```
#[inline(always)]
pub const fn is_not_full(&self) -> bool {
self.length < N
}
/// Returns a constant pointer to the first element of the StaticVec's internal array.
/// It is up to the caller to ensure that the StaticVec lives for as long as they intend
/// to make use of the returned pointer, as once the StaticVec is dropped the pointer will
/// point to uninitialized or "garbage" memory.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let v = staticvec!['A', 'B', 'C'];
/// let p = v.as_ptr();
/// unsafe { assert_eq!(*p, 'A') };
/// ```
#[inline(always)]
pub const fn as_ptr(&self) -> *const T {
// This is the same aliasing-avoidance / optimization-trick approach used by regular Vec.
let res = self.data.as_ptr() as *const T;
// A pointer to "element zero" of an array is never null.
unsafe {
assume(!res.is_null());
}
res
}
/// Returns a mutable pointer to the first element of the StaticVec's internal array.
/// It is up to the caller to ensure that the StaticVec lives for as long as they intend
/// to make use of the returned pointer, as once the StaticVec is dropped the pointer will
/// point to uninitialized or "garbage" memory.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = staticvec!['A', 'B', 'C'];
/// let p = v.as_mut_ptr();
/// unsafe { *p = 'X' };
/// assert_eq!(v, ['X', 'B', 'C']);
/// ```
#[inline(always)]
pub const fn as_mut_ptr(&mut self) -> *mut T {
// See the comment above in `as_ptr()`.
let res = self.data.as_mut_ptr() as *mut T;
unsafe {
assume(!res.is_null());
}
res
}
/// Returns a constant reference to a slice of the StaticVec's inhabited area.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// assert_eq!(staticvec![1, 2, 3].as_slice(), &[1, 2, 3]);
/// ```
#[inline(always)]
pub const fn as_slice(&self) -> &[T] {
// Safety: `self.as_ptr()` is a pointer to an array for which the first `length`
// elements are guaranteed to be initialized. Therefore this is a valid slice.
unsafe { from_raw_parts(self.as_ptr(), self.length) }
}
/// Returns a mutable reference to a slice of the StaticVec's inhabited area.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = staticvec![4, 5, 6];
/// let s = v.as_mut_slice();
/// s[1] = 9;
/// assert_eq!(v, [4, 9, 6]);
/// ```
#[inline(always)]
pub const fn as_mut_slice(&mut self) -> &mut [T] {
// Safety: See as_slice.
unsafe { from_raw_parts_mut(self.as_mut_ptr(), self.length) }
}
/// Returns a constant pointer to the element of the StaticVec at `index` without doing any
/// checking to ensure that `index` is actually within any particular bounds. The return value of
/// this function is equivalent to what would be returned from `as_ptr().add(index)`.
///
/// # Safety
///
/// It is up to the caller to ensure that `index` is within the appropriate bounds such that the
/// function returns a pointer to a location that falls somewhere inside the full span of the
/// StaticVec's backing array, and that if reading from the returned pointer, it has *already*
/// been initialized properly.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let v = staticvec!["I", "am", "a", "StaticVec!"];
/// unsafe {
/// let p = v.ptr_at_unchecked(3);
/// assert_eq!(*p, "StaticVec!");
/// }
/// ```
#[inline(always)]
pub const unsafe fn ptr_at_unchecked(&self, index: usize) -> *const T {
// We (inclusively, to account for the possibility of `N` being 0) check against `N` as opposed
// to `length` in our debug assertion here, as these `_unchecked` versions of `ptr_at` and
// `mut_ptr_at` are primarily intended for initialization-related purposes (and used extensively
// that way internally throughout the crate.)
/*
// The formatted assertion macros are not const-compatible yet.
debug_assert!(
index <= N,
"In `StaticVec::ptr_at_unchecked`, provided index {} must be within `0..={}`!",
index,
N
);
*/
debug_assert!(
index <= N,
"Bounds check failure in `StaticVec::ptr_at_unchecked`!",
);
// Safety: `index` is explicitly a `usize` to start with, and so cannot be negative at this
// point.
self.as_ptr().add(index)
}
/// Returns a mutable pointer to the element of the StaticVec at `index` without doing any
/// checking to ensure that `index` is actually within any particular bounds. The return value of
/// this function is equivalent to what would be returned from `as_mut_ptr().add(index)`.
///
/// # Safety
///
/// It is up to the caller to ensure that `index` is within the appropriate bounds such that the
/// function returns a pointer to a location that falls somewhere inside the full span of the
/// StaticVec's backing array.
///
/// It is also the responsibility of the caller to ensure that the `length` field of the StaticVec
/// is adjusted to properly reflect whatever range of elements this function may be used to
/// initialize, and that if reading from the returned pointer, it has *already* been initialized
/// properly.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = staticvec!["I", "am", "not a", "StaticVec!"];
/// unsafe {
/// let p = v.mut_ptr_at_unchecked(2);
/// *p = "a";
/// }
/// assert_eq!(v, ["I", "am", "a", "StaticVec!"]);
/// ```
#[inline(always)]
pub const unsafe fn mut_ptr_at_unchecked(&mut self, index: usize) -> *mut T {
// We (inclusively, to account for the possibility of `N` being 0) check against `N` as opposed
// to `length` in our debug assertion here, as these `_unchecked` versions of `ptr_at` and
// `mut_ptr_at` are primarily intended for initialization-related purposes (and used extensively
// that way internally throughout the crate.)
/*
// The formatted assertion macros are not const-compatible yet.
debug_assert!(
index <= N,
"In `StaticVec::mut_ptr_at_unchecked`, provided index {} must be within `0..={}`!",
index,
N
);
*/
debug_assert!(
index <= N,
"Bounds check failure in `StaticVec::mut_ptr_at_unchecked`!",
);
// Safety: `index` is explicitly a `usize` to start with, and so cannot be negative at this
// point.
self.as_mut_ptr().add(index)
}
/// Returns a constant pointer to the element of the StaticVec at `index` if `index`
/// is within the range `0..self.length`, or panics if it is not. The return value of this
/// function is equivalent to what would be returned from `as_ptr().add(index)`.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let v = staticvec!["I", "am", "a", "StaticVec!"];
/// let p = v.ptr_at(3);
/// unsafe { assert_eq!(*p, "StaticVec!") };
/// ```
#[inline(always)]
pub const fn ptr_at(&self, index: usize) -> *const T {
/*
// The formatted assertion macros are not const-compatible yet.
assert!(
index < self.length,
"In `StaticVec::ptr_at`, provided index {} must be within `0..{}`!",
index,
self.length
);
*/
assert!(
index < self.length,
"Bounds check failure in `StaticVec::ptr_at`!"
);
unsafe { self.ptr_at_unchecked(index) }
}
/// Returns a mutable pointer to the element of the StaticVec at `index` if `index`
/// is within the range `0..self.length`, or panics if it is not. The return value of this
/// function is equivalent to what would be returned from `as_mut_ptr().add(index)`.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = staticvec!["I", "am", "not a", "StaticVec!"];
/// let p = v.mut_ptr_at(2);
/// unsafe { *p = "a" };
/// assert_eq!(v, ["I", "am", "a", "StaticVec!"]);
/// ```
#[inline(always)]
pub const fn mut_ptr_at(&mut self, index: usize) -> *mut T {
/*
// The formatted assertion macros are not const-compatible yet.
assert!(
index < self.length,
"In `StaticVec::mut_ptr_at`, provided index {} must be within `0..{}`!",
index,
self.length
);
*/
assert!(
index < self.length,
"Bounds check failure in `StaticVec::mut_ptr_at`!"
);
unsafe { self.mut_ptr_at_unchecked(index) }
}
/// Returns a constant reference to the element of the StaticVec at `index` without doing any
/// checking to ensure that `index` is actually within any particular bounds.
///
/// Note that unlike [`slice::get_unchecked`](https://doc.rust-lang.org/nightly/std/primitive.slice.html#method.get_unchecked),
/// this method only supports accessing individual elements via `usize`; it cannot also produce
/// subslices. To get a subslice without a bounds check, use
/// `self.as_slice().get_unchecked(a..b)`.
///
/// # Safety
///
/// It is up to the caller to ensure that `index` is within the range `0..self.length`.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// unsafe { assert_eq!(*staticvec![1, 2, 3].get_unchecked(1), 2) };
/// ```
#[inline(always)]
pub const unsafe fn get_unchecked(&self, index: usize) -> &T {
// This function is used internally in places where `length` has been intentionally
// temporarily set to zero, so we do our debug assertion against `N`.
/*
// The formatted assertion macros are not const-compatible yet.
debug_assert!(
index < N,
"In `StaticVec::get_unchecked`, provided index {} must be within `0..{}`!",
index,
N
);
*/
debug_assert!(
index < N,
"Bounds check failure in `StaticVec::get_unchecked`!"
);
&*self.ptr_at_unchecked(index)
}
/// Returns a mutable reference to the element of the StaticVec at `index` without doing any
/// checking to ensure that `index` is actually within any particular bounds.
///
/// The same differences between this method and the slice method of the same name
/// apply as do for [`get_unchecked`](crate::StaticVec::get_unchecked).
///
/// # Safety
///
/// It is up to the caller to ensure that `index` is within the range `0..self.length`.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = staticvec![1, 2, 3];
/// let p = unsafe { v.get_unchecked_mut(1) };
/// *p = 9;
/// assert_eq!(v, [1, 9, 3]);
/// ```
#[inline(always)]
pub const unsafe fn get_unchecked_mut(&mut self, index: usize) -> &mut T {
// This function is used internally in places where `length` has been intentionally
// temporarily set to zero, so we do our debug assertion against `N`.
/*
// The formatted assertion macros are not const-compatible yet.
debug_assert!(
index < N,
"In `StaticVec::get_unchecked_mut`, provided index {} must be within `0..{}`!",
index,
N
);
*/
debug_assert!(
index < N,
"Bounds check failure in `StaticVec::get_unchecked_mut`!"
);
&mut *self.mut_ptr_at_unchecked(index)
}
/// Appends a value to the end of the StaticVec without asserting that
/// its current length is less than `N`.
///
/// # Safety
///
/// It is up to the caller to ensure that the length of the StaticVec
/// prior to using this function is less than `N`. Failure to do so will result
/// in writing to an out-of-bounds memory region.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = StaticVec::<i32, 4>::from([1, 2]);
/// unsafe { v.push_unchecked(3) };
/// assert_eq!(v, [1, 2, 3]);
/// ```
#[inline(always)]
pub const unsafe fn push_unchecked(&mut self, value: T) {
debug_assert!(
self.is_not_full(),
"`StaticVec::push_unchecked` was called through a StaticVec already at maximum capacity!"
);
let length = self.length;
self.mut_ptr_at_unchecked(length).write(value);
self.set_len(length + 1);
}
/// Pops a value from the end of the StaticVec and returns it directly without asserting that
/// the StaticVec's current length is greater than 0.
///
/// # Safety
///
/// It is up to the caller to ensure that the StaticVec contains at least one
/// element prior to using this function. Failure to do so will result in reading
/// from uninitialized memory.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = StaticVec::<i32, 4>::from([1, 2, 3, 4]);
/// unsafe { v.pop_unchecked() };
/// assert_eq!(v, [1, 2, 3]);
/// ```
#[inline(always)]
pub const unsafe fn pop_unchecked(&mut self) -> T {
debug_assert!(
self.is_not_empty(),
"`StaticVec::pop_unchecked` was called through an empty StaticVec!"
);
let new_length = self.length - 1;
self.set_len(new_length);
self.ptr_at_unchecked(new_length).read()
}
/// Pushes `value` to the StaticVec if its current length is less than its capacity,
/// or returns a [`PushCapacityError`](crate::errors::PushCapacityError) otherwise.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v1 = StaticVec::<usize, 128>::filled_with_by_index(|i| i * 4);
/// assert!(v1.try_push(999).is_err());
/// let mut v2 = StaticVec::<usize, 128>::new();
/// assert!(v2.try_push(1).is_ok());
/// ```
#[inline(always)]
pub const fn try_push(&mut self, value: T) -> Result<(), PushCapacityError<T, N>> {
if self.is_not_full() {
unsafe { self.push_unchecked(value) };
Ok(())
} else {
Err(PushCapacityError::new(value))
}
}
/// Pushes a value to the end of the StaticVec. Panics if the collection is
/// full; that is, if `self.len() == self.capacity()`.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = StaticVec::<i32, 8>::new();
/// v.push(1);
/// v.push(2);
/// assert_eq!(v, [1, 2]);
/// ```
#[inline(always)]
pub const fn push(&mut self, value: T) {
assert!(
self.is_not_full(),
"`StaticVec::push` was called through a StaticVec already at maximum capacity!"
);
unsafe { self.push_unchecked(value) };
}
/// Removes the value at the last position of the StaticVec and returns it in `Some` if
/// the StaticVec has a current length greater than 0, and returns `None` otherwise.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = staticvec![1, 2, 3, 4];
/// assert_eq!(v.pop(), Some(4));
/// assert_eq!(v.pop(), Some(3));
/// assert_eq!(v, [1, 2]);
/// ```
#[inline(always)]
pub const fn pop(&mut self) -> Option<T> {
if self.is_empty() {
None
} else {
Some(unsafe { self.pop_unchecked() })
}
}
/// Returns a constant reference to the first element of the StaticVec in `Some` if the StaticVec
/// is not empty, or `None` otherwise.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let v1 = staticvec![10, 40, 30];
/// assert_eq!(Some(&10), v1.first());
/// let v2 = StaticVec::<i32, 0>::new();
/// assert_eq!(None, v2.first());
/// ```
#[inline(always)]
pub const fn first(&self) -> Option<&T> {
if self.is_empty() {
None
} else {
Some(unsafe { self.get_unchecked(0) })
}
}
/// Returns a mutable reference to the first element of the StaticVec in `Some` if the StaticVec
/// is not empty, or `None` otherwise.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut x = staticvec![0, 1, 2];
/// if let Some(first) = x.first_mut() {
/// *first = 5;
/// }
/// assert_eq!(x, &[5, 1, 2]);
/// ```
#[inline(always)]
pub const fn first_mut(&mut self) -> Option<&mut T> {
if self.is_empty() {
None
} else {
Some(unsafe { self.get_unchecked_mut(0) })
}
}
/// Returns a constant reference to the last element of the StaticVec in `Some` if the StaticVec
/// is not empty, or `None` otherwise.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let v = staticvec![10, 40, 30];
/// assert_eq!(Some(&30), v.last());
/// let w = StaticVec::<i32, 0>::new();
/// assert_eq!(None, w.last());
/// ```
#[inline(always)]
pub const fn last(&self) -> Option<&T> {
if self.is_empty() {
None
} else {
Some(unsafe { self.get_unchecked(self.length - 1) })
}
}
/// Returns a mutable reference to the last element of the StaticVec in `Some` if the StaticVec is
/// not empty, or `None` otherwise.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut x = staticvec![0, 1, 2];
/// if let Some(last) = x.last_mut() {
/// *last = 10;
/// }
/// assert_eq!(x, &[0, 1, 10]);
/// ```
#[inline(always)]
pub const fn last_mut(&mut self) -> Option<&mut T> {
if self.is_empty() {
None
} else {
Some(unsafe { self.get_unchecked_mut(self.length - 1) })
}
}
/// A crate-local unchecked version of `remove`, currently only used in the implementation of
/// `StaticVecSplice`.
#[inline]
pub(crate) const fn remove_unchecked(&mut self, index: usize) -> T {
let old_length = self.length;
unsafe {
let self_ptr = self.mut_ptr_at_unchecked(index);
let res = self_ptr.read();
self_ptr.offset(1).copy_to(self_ptr, old_length - index - 1);
self.set_len(old_length - 1);
res
}
}
/// Asserts that `index` is less than the current length of the StaticVec,
/// and if so removes the value at that position and returns it. Any values
/// that exist in later positions are shifted to the left.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// assert_eq!(staticvec![1, 2, 3].remove(1), 2);
/// ```
#[inline]
pub const fn remove(&mut self, index: usize) -> T {
let old_length = self.length;
assert!(
index < old_length,
"Bounds check failure in `StaticVec::remove`!"
);
unsafe {
let self_ptr = self.mut_ptr_at_unchecked(index);
assume(!self_ptr.is_null());
let res = self_ptr.read();
self_ptr.offset(1).copy_to(self_ptr, old_length - index - 1);
self.set_len(old_length - 1);
res
}
}
/// Removes the first instance of `item` from the StaticVec if the item exists.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// assert_eq!(staticvec![1, 2, 2, 3].remove_item(&2), Some(2));
/// ```
#[allow(clippy::manual_map)]
#[inline(always)]
pub fn remove_item(&mut self, item: &T) -> Option<T>
where T: PartialEq {
// Adapted this from normal Vec's implementation.
if let Some(pos) = self.iter().position(|x| *x == *item) {
Some(self.remove(pos))
} else {
None
}
}
/// Returns `None` if `index` is greater than or equal to the current length of the StaticVec.
/// Otherwise, removes the value at that position and returns it in `Some`, and then
/// moves the last value in the StaticVec into the empty slot.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = staticvec!["AAA", "BBB", "CCC", "DDD"];
/// assert_eq!(v.swap_pop(1).unwrap(), "BBB");
/// assert_eq!(v, ["AAA", "DDD", "CCC"]);
/// ```
#[inline(always)]
pub const fn swap_pop(&mut self, index: usize) -> Option<T> {
if index < self.length {
unsafe {
let new_length = self.length - 1;
let last_value = self.ptr_at_unchecked(new_length).read();
self.set_len(new_length);
Some(ptr::replace(self.mut_ptr_at_unchecked(index), last_value))
}
} else {
None
}
}
/// Asserts that `index` is less than the current length of the StaticVec,
/// and if so removes the value at that position and returns it, and then
/// moves the last value in the StaticVec into the empty slot.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = staticvec!["AAA", "BBB", "CCC", "DDD"];
/// assert_eq!(v.swap_remove(1), "BBB");
/// assert_eq!(v, ["AAA", "DDD", "CCC"]);
/// ```
#[inline(always)]
pub const fn swap_remove(&mut self, index: usize) -> T {
assert!(
index < self.length,
"Bounds check failure in `StaticVec::swap_remove`!"
);
unsafe {
let new_length = self.length - 1;
let last_value = self.ptr_at_unchecked(new_length).read();
self.set_len(new_length);
ptr::replace(self.mut_ptr_at_unchecked(index), last_value)
}
}
/// Asserts that the current length of the StaticVec is less than `N` and that
/// `index` is less than the length, and if so inserts `value` at that position.
/// Any values that exist in positions after `index` are shifted to the right.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = StaticVec::<i32, 5>::from([1, 2, 3]);
/// v.insert(1, 4);
/// assert_eq!(v, [1, 4, 2, 3]);
/// ```
#[inline]
pub const fn insert(&mut self, index: usize, value: T) {
let old_length = self.length;
assert!(
old_length < N && index <= old_length,
"Insufficient remaining capacity or bounds check failure in `StaticVec::insert`!"
);
unsafe {
let self_ptr = self.mut_ptr_at_unchecked(index);
self_ptr.copy_to(self_ptr.offset(1), old_length - index);
self_ptr.write(value);
self.set_len(old_length + 1);
}
}
/// Functionally equivalent to [`insert`](crate::StaticVec::insert), except with multiple
/// items provided by an iterator as opposed to just one. This function will panic up-front if
/// `index` is out of bounds or if the StaticVec does not have a sufficient amount of remaining
/// capacity, but once the iteration has started will just return immediately if / when the
/// StaticVec reaches maximum capacity, regardless of whether the iterator still has more items
/// to yield.
///
/// For safety reasons, as StaticVec cannot increase in capacity, the
/// iterator is required to implement [`ExactSizeIterator`](core::iter::ExactSizeIterator)
/// rather than just [`Iterator`](core::iter::Iterator) (though this function still does
/// the appropriate checking internally to avoid dangerous outcomes in the event of a blatantly
/// incorrect [`ExactSizeIterator`](core::iter::ExactSizeIterator) implementation.)
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = StaticVec::<usize, 8>::from([1, 2, 3, 4, 7, 8]);
/// v.insert_many(4, staticvec![5, 6].into_iter());
/// assert_eq!(v, [1, 2, 3, 4, 5, 6, 7, 8]);
/// ```
#[inline]
pub fn insert_many<I: IntoIterator<Item = T>>(&mut self, index: usize, iter: I)
where I::IntoIter: ExactSizeIterator<Item = T> {
let old_length = self.length;
assert!(
old_length < N && index <= old_length,
"Insufficient remaining capacity or bounds check failure in `StaticVec::insert_many`!"
);
let mut it = iter.into_iter();
if index == old_length {
return self.extend(it);
}
let iter_size = it.len();
assert!(
index + iter_size >= index && (old_length - index) + iter_size < N,
"Insufficient remaining capacity or bounds check failure in `StaticVec::insert_many`!"
);
unsafe {
let mut self_ptr = self.mut_ptr_at_unchecked(index);
self_ptr.copy_to(self_ptr.add(iter_size), old_length - index);
self.length = index;
let mut item_count = 0;
while item_count < N {
if let Some(item) = it.next() {
let mut current = self_ptr.add(item_count);
if item_count >= iter_size {
self_ptr = self.mut_ptr_at_unchecked(index);
current = self_ptr.add(item_count);
current.copy_to(current.offset(1), old_length - index);
}
current.write(item);
item_count += 1;
} else {
break;
}
}
self.set_len(old_length + item_count);
}
}
/// Functionally equivalent to [`insert_many`](crate::StaticVec::insert_many), except with
/// multiple items provided by a slice reference as opposed to an arbitrary iterator. Locally
/// requires that `T` implements [`Copy`](core::marker::Copy) to avoid soundness issues.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = StaticVec::<usize, 8>::from([1, 2, 3, 4, 7, 8]);
/// v.insert_from_slice(4, &[5, 6]);
/// assert_eq!(v, [1, 2, 3, 4, 5, 6, 7, 8]);
/// ```
#[inline]
pub const fn insert_from_slice(&mut self, index: usize, values: &[T])
where T: Copy {
let old_length = self.length;
let values_length = values.len();
assert!(
old_length < N && index <= old_length && values_length <= self.remaining_capacity(),
"Insufficient remaining capacity or bounds check failure in `StaticVec::insert_from_slice`!"
);
unsafe {
let self_ptr = self.mut_ptr_at_unchecked(index);
self_ptr.copy_to(self_ptr.add(values_length), old_length - index);
self_ptr.copy_from_nonoverlapping(values.as_ptr(), values_length);
self.set_len(old_length + values_length);
}
}
/// Inserts `value` at `index` if the current length of the StaticVec is less than `N` and `index`
/// is less than the length, or returns a [`CapacityError`](crate::errors::CapacityError)
/// otherwise. Any values that exist in positions after `index` are shifted to the right.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut vec = StaticVec::<i32, 5>::from([1, 2, 3, 4, 5]);
/// assert_eq!(vec.try_insert(2, 0), Err(CapacityError::<5> {}));
/// ```
#[inline]
pub fn try_insert(&mut self, index: usize, value: T) -> Result<(), CapacityError<N>> {
let old_length = self.length;
if old_length < N && index <= old_length {
unsafe {
let self_ptr = self.mut_ptr_at_unchecked(index);
self_ptr.copy_to(self_ptr.offset(1), old_length - index);
self_ptr.write(value);
self.set_len(old_length + 1);
}
Ok(())
} else {
Err(CapacityError {})
}
}
/// Does the same thing as [`insert_from_slice`](crate::StaticVec::insert_from_slice), but returns
/// a [`CapacityError`](crate::errors::CapacityError) in the event that something goes wrong as
/// opposed to relying on internal assertions.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v1 = StaticVec::<usize, 8>::from([1, 2, 3, 4, 7, 8]);
/// assert!(v1.try_insert_from_slice(4, &[5, 6]).is_ok());
/// assert_eq!(v1, [1, 2, 3, 4, 5, 6, 7, 8]);
/// let mut v2 = StaticVec::<usize, 8>::from([1, 2, 3, 4, 7, 8]);
/// assert!(v2.try_insert_from_slice(207, &[5, 6]).is_err());
/// ```
#[inline]
pub const fn try_insert_from_slice(
&mut self,
index: usize,
values: &[T],
) -> Result<(), CapacityError<N>>
where
T: Copy,
{
let old_length = self.length;
let values_length = values.len();
if old_length < N && index <= old_length && values_length <= self.remaining_capacity() {
unsafe {
let self_ptr = self.mut_ptr_at_unchecked(index);
self_ptr.copy_to(self_ptr.add(values_length), old_length - index);
self_ptr.copy_from_nonoverlapping(values.as_ptr(), values_length);
self.set_len(old_length + values_length);
}
Ok(())
} else {
Err(CapacityError {})
}
}
/// Returns `true` if `value` is present in the StaticVec.
/// Locally requires that `T` implements [`PartialEq`](core::cmp::PartialEq)
/// to make it possible to compare the elements of the StaticVec with `value`.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// assert_eq!(staticvec![1, 2, 3].contains(&2), true);
/// assert_eq!(staticvec![1, 2, 3].contains(&4), false);
/// ```
#[inline(always)]
pub fn contains(&self, value: &T) -> bool
where T: PartialEq {
self.iter().any(|current| current == value)
}
/// Removes all contents from the StaticVec and sets its length back to 0.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = staticvec![1, 2, 3];
/// assert_eq!(v.len(), 3);
/// assert_eq!(v, [1, 2, 3]);
/// v.clear();
/// assert_eq!(v.len(), 0);
/// assert_eq!(v, []);
/// ```
#[inline(always)]
pub fn clear(&mut self) {
// Safety: `self.as_mut_slice()` will always return either a slice of values that are known to
// be initialized, or simply a benign empty slice if the StaticVec it is called through is
// empty.
unsafe { ptr::drop_in_place(self.as_mut_slice()) };
self.length = 0;
}
/// Returns a [`StaticVecIterConst`](crate::iterators::StaticVecIterConst) over the StaticVec's
/// inhabited area.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let v = staticvec![4, 3, 2, 1];
/// for i in v.iter() {
/// println!("{}", i);
/// }
/// ```
#[inline(always)]
pub const fn iter(&self) -> StaticVecIterConst<T, N> {
let start_ptr = self.as_ptr();
unsafe {
// `start_ptr` will never be null, so this is a safe assumption to give the optimizer.
assume(!start_ptr.is_null());
StaticVecIterConst {
start: start_ptr,
end: match size_of::<T>() {
0 => zst_ptr_add(start_ptr, self.length),
_ => start_ptr.add(self.length),
},
marker: PhantomData,
}
}
}
/// Returns a [`StaticVecIterMut`](crate::iterators::StaticVecIterMut) over the StaticVec's
/// inhabited area.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = staticvec![4, 3, 2, 1];
/// for i in v.iter_mut() {
/// *i -= 1;
/// }
/// assert_eq!(v, [3, 2, 1, 0]);
/// ```
#[inline(always)]
pub const fn iter_mut(&mut self) -> StaticVecIterMut<T, N> {
let start_ptr = self.as_mut_ptr();
unsafe {
// `start_ptr` will never be null, so this is a safe assumption to give the optimizer.
assume(!start_ptr.is_null());
StaticVecIterMut {
start: start_ptr,
end: match size_of::<T>() {
0 => zst_ptr_add_mut(start_ptr, self.length),
_ => start_ptr.add(self.length),
},
marker: PhantomData,
}
}
}
/// Returns a separate, stable-sorted StaticVec of the contents of the StaticVec's inhabited area
/// without modifying the original data. Locally requires that `T` implements
/// [`Copy`](core::marker::Copy) to avoid soundness issues, and [`Ord`](core::cmp::Ord) to make
/// the sorting possible.
///
/// # Example usage:
/// ```
/// # use staticvec::{staticvec, StaticVec};
/// const V: StaticVec<StaticVec<i32, 2>, 2> = staticvec![staticvec![1, 3], staticvec![4, 2]];
/// assert_eq!(
/// V.iter().flatten().collect::<StaticVec<i32, 4>>().sorted(),
/// [1, 2, 3, 4]
/// );
/// ```
#[cfg(feature = "std")]
#[doc(cfg(feature = "std"))]
#[inline]
pub fn sorted(&self) -> Self
where T: Copy + Ord {
// StaticVec uses specialization to have an optimized version of `Clone` for copy types.
let mut res = self.clone();
res.sort();
res
}
/// Returns a separate, unstable-sorted StaticVec of the contents of the StaticVec's inhabited
/// area without modifying the original data. Locally requires that `T` implements
/// [`Copy`](core::marker::Copy) to avoid soundness issues, and [`Ord`](core::cmp::Ord) to make
/// the sorting possible.
///
/// # Example usage:
/// ```
/// # use staticvec::{staticvec, StaticVec};
/// const V: StaticVec<StaticVec<i32, 2>, 2> = staticvec![staticvec![1, 3], staticvec![4, 2]];
/// assert_eq!(
/// V.iter().flatten().collect::<StaticVec<i32, 4>>().sorted_unstable(),
/// [1, 2, 3, 4]
/// );
/// ```
#[inline]
pub fn sorted_unstable(&self) -> Self
where T: Copy + Ord {
// StaticVec uses specialization to have an optimized version of `Clone` for copy types.
let mut res = self.clone();
res.sort_unstable();
res
}
/// Returns a separate, unstable-quicksorted StaticVec of the contents of the StaticVec's
/// inhabited area without modifying the original data. Locally requires that `T` implements
/// [`Copy`](core::marker::Copy) to avoid soundness issues, and
/// [`PartialOrd`](core::cmp::PartialOrd) to make the sorting possible.
///
/// Unlike [`sorted`](crate::StaticVec::sorted) and
/// [`sorted_unstable`](crate::StaticVec::sorted_unstable), this function does not make use of
/// Rust's built-in sorting methods, but instead makes direct use of a comparatively
/// unsophisticated recursive quicksort algorithm implemented in this crate.
///
/// This has the advantage of only needing to have [`PartialOrd`](core::cmp::PartialOrd) as a
/// constraint as opposed to [`Ord`](core::cmp::Ord), but is very likely less performant for
/// most inputs, so if the type you're sorting does derive or implement
/// [`Ord`](core::cmp::Ord) it's recommended that you use [`sorted`](crate::StaticVec::sorted) or
/// [`sorted_unstable`](crate::StaticVec::sorted_unstable) instead of this function.
///
/// # Example usage:
/// ```
/// # use staticvec::{staticvec, StaticVec};
/// const V: StaticVec<StaticVec<i32, 2>, 2> = staticvec![staticvec![1, 3], staticvec![4, 2]];
/// assert_eq!(
/// V.iter().flatten().collect::<StaticVec<i32, 4>>().quicksorted_unstable(),
/// [1, 2, 3, 4]
/// );
/// ```
#[inline]
pub const fn quicksorted_unstable(&self) -> Self
where T: Copy + ~const PartialOrd {
let length = self.length;
if length < 2 {
// StaticVec uses specialization to have an optimized verson of `Clone` for copy types.
return self.clone();
}
let mut res = Self::new_data_uninit();
let res_ptr = Self::first_ptr_mut(&mut res);
// Copy the inhabited part of `self` into the array we'll use for the returned StaticVec.
unsafe { self.as_ptr().copy_to_nonoverlapping(res_ptr, length) };
// Sort the array, and then build and return a new StaticVec from it.
quicksort_internal(res_ptr, 0, (length - 1) as isize);
Self { data: res, length }
}
/// Provides the same sorting functionality as
/// [`quicksorted_unstable`](crate::StaticVec::quicksorted_unstable) (and has the same trait
/// bound requirements) but operates in-place on the calling StaticVec instance rather than
/// returning the sorted data in a new one.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = staticvec![5.0, 4.0, 3.0, 2.0, 1.0];
/// v.quicksort_unstable();
/// assert_eq!(v, [1.0, 2.0, 3.0, 4.0, 5.0]);
/// // Note that if you are actually sorting floating-point numbers as shown above, and the
/// // StaticVec contains one or more instances of NAN, the "accuracy" of the sorting will
/// // essentially be determined by a combination of how many *consecutive* NANs there are,
/// // as well as how "mixed up" the surrounding valid numbers were to begin with. In any case,
/// // the outcome of this particular hypothetical scenario will never be any worse than the
/// // values simply not being sorted quite as you'd hoped.
/// ```
#[inline]
pub const fn quicksort_unstable(&mut self)
where T: Copy + ~const PartialOrd {
let length = self.length;
if length < 2 {
return;
}
let self_ptr = self.as_mut_ptr();
// We know self_ptr will never be null, so this is a safe hint to give the optimizer.
unsafe { assume(!self_ptr.is_null()) };
quicksort_internal(self_ptr, 0, (length - 1) as isize);
}
/// Returns a separate, reversed StaticVec of the contents of the StaticVec's inhabited area
/// without modifying the original data. Locally requires that `T` implements
/// [`Copy`](core::marker::Copy) to avoid soundness issues.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// assert_eq!(staticvec![1, 2, 3].reversed(), [3, 2, 1]);
/// ```
#[inline(always)]
pub const fn reversed(&self) -> Self
where T: Copy {
Self {
data: reverse_copy(self.length, &self.data),
length: self.length,
}
}
/// Returns a new StaticVec instance filled with the return value of an initializer function.
/// The length field of the newly created StaticVec will be equal to its capacity.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticVec;
/// let mut i = 0;
/// let v = StaticVec::<i32, 64>::filled_with(|| { i += 1; i });
/// assert_eq!(v.len(), 64);
/// assert_eq!(v[0], 1);
/// assert_eq!(v[1], 2);
/// assert_eq!(v[2], 3);
/// assert_eq!(v[3], 4);
/// ```
#[inline]
pub fn filled_with<F: FnMut() -> T>(mut initializer: F) -> Self {
let mut res = Self::new();
for i in 0..N {
unsafe {
res.mut_ptr_at_unchecked(i).write(initializer());
}
// Adjusting the length of `res` as we go ensures any items already written to it will be
// dropped properly in the event that `initializer` panics at some point.
res.length += 1;
}
res
}
/// Returns a new StaticVec instance filled with the return value of an initializer function.
/// Unlike for [`filled_with`](crate::StaticVec::filled_with), the initializer function in
/// this case must take a single usize variable as an input parameter, which will be called
/// with the current index of the `0..N` loop that
/// [`filled_with_by_index`](crate::StaticVec::filled_with_by_index) is implemented with
/// internally. The length field of the newly created StaticVec will be equal to its capacity.
///
/// # Example usage:
/// ```
/// # use staticvec::StaticVec;
/// let v = StaticVec::<usize, 64>::filled_with_by_index(|i| { i + 1 });
/// assert_eq!(v.len(), 64);
/// assert_eq!(v[0], 1);
/// assert_eq!(v[1], 2);
/// assert_eq!(v[2], 3);
/// assert_eq!(v[3], 4);
/// ```
#[inline]
pub fn filled_with_by_index<F: FnMut(usize) -> T>(mut initializer: F) -> Self {
let mut res = Self::new();
for i in 0..N {
unsafe {
res.mut_ptr_at_unchecked(i).write(initializer(i));
}
// Adjusting the length of `res` as we go ensures any items already written to it will be
// dropped properly in the event that `initializer` panics at some point.
res.length += 1;
}
res
}
/// Copies and appends all elements, if any, of a slice (which can also be `&mut` as it will
/// coerce implicitly to `&`) to the StaticVec. If the slice has a length greater than the
/// StaticVec's remaining capacity, any contents after that point are ignored.
/// Locally requires that `T` implements [`Copy`](core::marker::Copy) to avoid soundness issues.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = StaticVec::<i32, 8>::new();
/// v.extend_from_slice(&[1, 2, 3, 4]);
/// v.extend_from_slice(&[5, 6, 7, 8, 9, 10, 11]);
/// assert_eq!(v, [1, 2, 3, 4, 5, 6, 7, 8]);
/// ```
#[inline(always)]
pub const fn extend_from_slice(&mut self, values: &[T])
where T: Copy {
let old_length = self.length;
let added_length = const_min(values.len(), N - old_length);
// Safety: added_length is <= our remaining capacity and values.len.
unsafe {
values
.as_ptr()
.copy_to_nonoverlapping(self.mut_ptr_at_unchecked(old_length), added_length);
self.set_len(old_length + added_length);
}
}
/// Copies and appends all elements, if any, of a slice to the StaticVec if the
/// StaticVec's remaining capacity is greater than the length of the slice, or returns
/// a [`CapacityError`](crate::errors::CapacityError) otherwise.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = StaticVec::<i32, 8>::new();
/// assert!(v.try_extend_from_slice(&[1, 2, 3, 4]).is_ok());
/// assert!(v.try_extend_from_slice(&[5, 6, 7, 8, 9, 10, 11]).is_err());
/// assert_eq!(v, [1, 2, 3, 4]);
/// ```
#[inline(always)]
pub fn try_extend_from_slice(&mut self, values: &[T]) -> Result<(), CapacityError<N>>
where T: Copy {
let old_length = self.length;
let added_length = values.len();
if N - old_length < added_length {
return Err(CapacityError {});
}
unsafe {
values
.as_ptr()
.copy_to_nonoverlapping(self.mut_ptr_at_unchecked(old_length), added_length);
self.set_len(old_length + added_length);
}
Ok(())
}
/// Appends `self.remaining_capacity()` (or as many as available) items from
/// `other` to `self`. The appended items (if any) will no longer exist in `other` afterwards,
/// as `other`'s `length` field will be adjusted to indicate.
///
/// The `N2` parameter does not need to be provided explicitly, and can be inferred directly from
/// the constant `N2` constraint of `other` (which may or may not be the same as the `N`
/// constraint of `self`.)
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut a = StaticVec::<i32, 8>::from([1, 2, 3, 4]);
/// let mut b = staticvec![1, 2, 3, 4, 5, 6, 7, 8];
/// a.append(&mut b);
/// assert_eq!(a.len(), 8);
/// assert_eq!(a, [1, 2, 3, 4, 1, 2, 3, 4]);
/// assert_eq!(b, [5, 6, 7, 8]);
/// ```
#[inline]
pub const fn append<const N2: usize>(&mut self, other: &mut StaticVec<T, N2>) {
let old_length = self.length;
// Get the maximum number of items both within our capacity and within
// what `other` actually has to offer.
let item_count = const_min(N - old_length, other.length);
// Calculate what the length of `other` should be changed to once we've
// moved the items from it into self.
let other_new_length = other.length - item_count;
unsafe {
// Copy over the items.
self
.mut_ptr_at_unchecked(old_length)
.copy_from_nonoverlapping(other.as_ptr(), item_count);
// Shift the items leftwards in `other` if / as necessary. This only
// really does anything if it's the case that the remaining capacity
// of `self` was less than the number of items `other` had available.
other
.as_mut_ptr()
.copy_from(other.ptr_at_unchecked(item_count), other_new_length);
// Adjust the lengths of `other` and `self`.
other.set_len(other_new_length);
self.set_len(old_length + item_count);
}
}
/// Returns a new StaticVec consisting of the elements of `self` and `other` concatenated in
/// linear fashion such that the first element of `other` comes immediately after the last
/// element of `self`.
///
/// The `N2` parameter does not need to be provided explicitly, and can be inferred directly from
/// the constant `N2` constraint of `other` (which may or may not be the same as the `N`
/// constraint of `self`.)
///
/// Locally requires that `T` implements [`Copy`](core::marker::Copy) to
/// avoid soundness issues and also allow for a more efficient implementation than would otherwise
/// be possible.
///
/// # Example usage:
/// ```
/// # use staticvec::staticvec;
/// assert!(staticvec!['a', 'b'].concat(&staticvec!['c', 'd']) == ['a', 'b', 'c', 'd']);
/// ```
#[inline]
pub const fn concat<const N2: usize>(
&self,
other: &StaticVec<T, N2>,
) -> StaticVec<T, { N + N2 }>
where
T: Copy,
{
let length = self.length;
let other_length = other.length;
let mut res = StaticVec::new_data_uninit();
let res_ptr = res.as_mut_ptr() as *mut T;
unsafe {
// Copy over all of `self`.
self.as_ptr().copy_to_nonoverlapping(res_ptr, length);
// Copy over all of `other` starting at the position immediately following
// the last occupied position of the copy we just did from `self`.
other
.as_ptr()
.copy_to_nonoverlapping(res_ptr.add(length), other_length);
}
StaticVec {
data: res,
length: length + other_length,
}
}
/// A version of [`concat`](crate::StaticVec::concat) for scenarios where `T` does not
/// derive [`Copy`](core::marker::Copy) but does implement [`Clone`](core::clone::Clone).
///
/// Due to needing to call `clone()` through each individual element of `self` and `other`, this
/// function is less efficient than [`concat`](crate::StaticVec::concat), so
/// [`concat`](crate::StaticVec::concat) should be preferred whenever possible.
///
/// # Example usage:
/// ```
/// # use staticvec::staticvec;
/// assert!(staticvec!["a", "b"].concat_clone(&staticvec!["c", "d"]) == ["a", "b", "c", "d"]);
/// ```
#[inline]
pub fn concat_clone<const N2: usize>(
&self,
other: &StaticVec<T, N2>,
) -> StaticVec<T, { N + N2 }>
where
T: Clone,
{
let mut res = StaticVec::new();
for item in self {
unsafe { res.push_unchecked(item.clone()) };
}
for item in other {
unsafe { res.push_unchecked(item.clone()) };
}
res
}
/// Returns a new StaticVec consisting of the elements of `self` in linear order, interspersed
/// with a copy of `separator` between each one.
///
/// Locally requires that `T` implements [`Copy`](core::marker::Copy) to
/// avoid soundness issues and also allow for a more efficient implementation than would otherwise
/// be possible.
///
/// # Example usage:
/// ```
/// # use staticvec::staticvec;
/// assert_eq!(
/// staticvec!["A", "B", "C", "D"].intersperse("Z"),
/// ["A", "Z", "B", "Z", "C", "Z", "D"]
/// );
/// ```
#[inline]
pub const fn intersperse(&self, separator: T) -> StaticVec<T, { N * 2 }>
where T: Copy {
if self.is_empty() {
return StaticVec::new();
}
let mut res = StaticVec::new_data_uninit();
// The `as *mut T` cast below is necessary to make the type inference work properly (at the
// moment at least). `rustc` still gets a bit confused by math operations done on const generic
// values in return types it seems.
// Note that the `StaticVec::new()` calls above *have* to be written without any constraints,
// as otherwise we'll hit a particular bug where `rustc` says:
// "expected struct `StaticVec<_, { N * 2 }>`, found struct `StaticVec<_, { N * 2 }>`".
let mut res_ptr = StaticVec::first_ptr_mut(&mut res) as *mut T;
let mut i = 0;
let length = self.length;
while i < length - 1 {
unsafe {
res_ptr.write(self.ptr_at_unchecked(i).read());
res_ptr.offset(1).write(separator);
res_ptr = res_ptr.offset(2);
}
i += 1;
}
unsafe {
res_ptr.write(self.ptr_at_unchecked(i).read());
}
StaticVec {
data: res,
length: (length * 2) - 1,
}
}
/// A version of [`intersperse`](crate::StaticVec::intersperse) for scenarios where `T` does not
/// derive [`Copy`](core::marker::Copy) but does implement [`Clone`](core::clone::Clone).
///
/// Due to needing to call `clone()` through each individual element of `self` and also on
/// `separator`, this function is less efficient than
/// [`intersperse`](crate::StaticVec::intersperse), so
/// [`intersperse`](crate::StaticVec::intersperse) should be preferred whenever possible.
///
/// # Example usage:
/// ```
/// # use staticvec::staticvec;
/// assert_eq!(
/// staticvec!["A", "B", "C", "D"].intersperse_clone("Z"),
/// ["A", "Z", "B", "Z", "C", "Z", "D"]
/// );
/// ```
#[inline]
pub fn intersperse_clone(&self, separator: T) -> StaticVec<T, { N * 2 }>
where T: Clone {
if self.is_empty() {
return StaticVec::new();
}
let mut res = StaticVec::new();
let length = self.length;
unsafe {
for i in 0..length - 1 {
res.push_unchecked(self.get_unchecked(i).clone());
res.push_unchecked(separator.clone());
}
res.push_unchecked(self.get_unchecked(length - 1).clone());
}
res
}
/// Returns a StaticVec containing the contents of a [`Vec`](alloc::vec::Vec) instance.
/// If the [`Vec`](alloc::vec::Vec) has a length greater than the declared capacity of the
/// resulting StaticVec, any contents after that point are ignored. Note that using this function
/// consumes the source [`Vec`](alloc::vec::Vec).
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = vec![1, 2, 3];
/// let sv: StaticVec<i32, 3> = StaticVec::from_vec(v);
/// assert_eq!(sv, [1, 2, 3]);
/// ```
#[cfg(feature = "std")]
#[doc(cfg(feature = "std"))]
#[inline]
pub fn from_vec(mut vec: Vec<T>) -> Self {
let vec_len = vec.len();
let item_count = vec_len.min(N);
Self {
data: {
// Set the length of `vec` to 0 to prevent double-drops.
unsafe { vec.set_len(0) };
let mut data = Self::new_data_uninit();
unsafe {
vec
.as_ptr()
.copy_to_nonoverlapping(Self::first_ptr_mut(&mut data), item_count);
// Manually drop any excess values in the source vec to avoid undesirable memory leaks.
if vec_len > item_count {
ptr::drop_in_place(from_raw_parts_mut(
vec.as_mut_ptr().add(item_count),
vec_len - item_count,
));
}
data
}
},
length: item_count,
}
}
/// Returns a [`Vec`](alloc::vec::Vec) containing the contents of the StaticVec instance.
/// The returned [`Vec`](alloc::vec::Vec) will initially have the same value for
/// [`len`](alloc::vec::Vec::len) and [`capacity`](alloc::vec::Vec::capacity) as the source
/// StaticVec. Note that using this function consumes the source StaticVec.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut sv = staticvec![1, 2, 3];
/// let v = sv.into_vec();
/// assert_eq!(v, [1, 2, 3]);
/// ```
#[cfg(feature = "std")]
#[doc(cfg(feature = "std"))]
#[inline(always)]
pub fn into_vec(mut self) -> Vec<T> {
let mut res = Vec::with_capacity(N);
let length = self.length;
unsafe {
self
.as_ptr()
.copy_to_nonoverlapping(res.as_mut_ptr(), length);
res.set_len(length);
// Set the length of `self` to 0 to prevent double-drops.
self.set_len(0);
res
}
}
/// Inspired by the function of the same name from `ArrayVec`, this function directly returns
/// the StaticVec's backing array (as a "normal" array not wrapped in an instance of
/// `MaybeUninit`) in `Ok` if and only if the StaticVec is at maximum capacity. Otherwise, the
/// StaticVec itself is returned in `Err`.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v1 = StaticVec::<i32, 4>::new();
/// v1.push(1);
/// v1.push(2);
/// let a = v1.into_inner();
/// assert!(a.is_err());
/// let v2 = staticvec![1, 2, 3, 4];
/// let a = v2.into_inner();
/// assert!(a.is_ok());
/// assert_eq!(a.unwrap(), [1, 2, 3, 4]);
/// ```
#[inline(always)]
pub const fn into_inner(self) -> Result<[T; N], Self> {
if self.is_not_full() {
Err(self)
} else {
// Read out the contents of `data`. The way we do it looks silly, but is the only way for this
// function to be const-compatible. Note that setting `self.length` to zero here is not
// necessary, as `drop` will not be called on this StaticVec, so there is no risk of
// double-drops.
unsafe {
Ok(
MaybeUninit::new(self)
.assume_init_mut()
.data
.assume_init_read(),
)
}
}
}
/// Removes the specified range of elements from the StaticVec and returns them in a new one.
///
/// # Panics
///
/// Panics if the range's starting point is greater than the end point or if the end point is
/// greater than the length of the StaticVec.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = staticvec![1, 2, 3];
/// let u = v.drain(1..);
/// assert_eq!(v, &[1]);
/// ```
// No Copy bounds here because the original StaticVec gives up all access to the values in
// question.
#[inline]
pub fn drain<R: RangeBounds<usize>>(&mut self, range: R) -> Self {
// Borrowed this part from normal Vec's implementation.
let old_length = self.length;
let start = match range.start_bound() {
Included(&idx) => idx,
Excluded(&idx) => idx + 1,
Unbounded => 0,
};
let end = match range.end_bound() {
Included(&idx) => idx + 1,
Excluded(&idx) => idx,
Unbounded => old_length,
};
assert!(
start <= end && end <= old_length,
"Bounds check failure in `StaticVec::drain`!"
);
let res_length = end - start;
Self {
data: {
let mut res = Self::new_data_uninit();
unsafe {
self
.ptr_at_unchecked(start)
.copy_to_nonoverlapping(Self::first_ptr_mut(&mut res), res_length);
let mp = self.as_mut_ptr();
mp.add(end).copy_to(mp.add(start), old_length - end);
self.set_len(old_length - res_length);
res
}
},
length: res_length,
}
}
/// Removes the specified range of elements from the StaticVec and returns them in a
/// [`StaticVecDrain`](crate::iterators::StaticVecDrain).
///
/// # Panics
///
/// Panics if the range's starting point is greater than the end point or if the end point is
/// greater than the length of the StaticVec.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v1 = staticvec![0, 4, 5, 6, 7];
/// let v2: StaticVec<i32, 3> = v1.drain_iter(1..4).rev().collect();
/// assert_eq!(v2, [6, 5, 4]);
/// ```
#[inline]
pub fn drain_iter<R: RangeBounds<usize>>(&mut self, range: R) -> StaticVecDrain<T, N> {
// Borrowed this part from normal Vec's implementation.
let length = self.length;
let start = match range.start_bound() {
Included(&idx) => idx,
Excluded(&idx) => idx + 1,
Unbounded => 0,
};
let end = match range.end_bound() {
Included(&idx) => idx + 1,
Excluded(&idx) => idx,
Unbounded => length,
};
assert!(
start <= end && end <= length,
"Bounds check failure in `StaticVec::drain_iter`!"
);
unsafe {
// Set the length to `start` to avoid memory issues if anything goes wrong with the Drain.
self.set_len(start);
let start_ptr = match size_of::<T>() {
0 => zst_ptr_add(self.as_ptr(), start),
_ => self.ptr_at_unchecked(start),
};
// `start_ptr` will never be null, so this is a safe assumption to give to
// the optimizer.
assume(!start_ptr.is_null());
// Create the StaticVecDrain from the specified range.
StaticVecDrain {
start: end,
length: length - end,
iter: StaticVecIterConst {
start: start_ptr,
end: match size_of::<T>() {
0 => zst_ptr_add(self.as_ptr(), end),
_ => self.ptr_at_unchecked(end),
},
marker: PhantomData,
},
vec: self,
}
}
}
/// Removes all elements in the StaticVec for which `filter` returns true and returns them in a
/// new one.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut numbers = staticvec![1, 2, 3, 4, 5, 6, 8, 9, 11, 13, 14, 15];
/// let evens = numbers.drain_filter(|x| *x % 2 == 0);
/// let odds = numbers;
/// assert_eq!(evens, [2, 4, 6, 8, 14]);
/// assert_eq!(odds, [1, 3, 5, 9, 11, 13, 15]);
/// ```
#[inline]
pub fn drain_filter<F: FnMut(&mut T) -> bool>(&mut self, mut filter: F) -> Self {
let old_length = self.length;
// Temporarily set our length to 0 to avoid double drops and such if anything
// goes wrong in the filter loop.
self.length = 0;
let mut res = Self::new();
let mut res_length = 0;
unsafe {
// If `self.length` was already 0, this loop is skipped completely.
for i in 0..old_length {
// This is fine because we intentionally set `self.length` to `0` ourselves just now.
if filter(self.get_unchecked_mut(i)) {
res
.mut_ptr_at_unchecked(res_length)
.write(self.ptr_at_unchecked(i).read());
res_length += 1;
} else if res_length > 0 {
let mp = self.as_mut_ptr();
mp.add(i).copy_to_nonoverlapping(mp.add(i - res_length), 1);
}
}
}
self.length = old_length - res_length;
res.length = res_length;
res
}
/// Replaces the specified range in the StaticVec with the contents of `replace_with` and returns
/// the removed items in an instance of [`StaticVecSplice`](crate::iterators::StaticVecSplice).
/// `replace_with` does not need to be the same length as `range`. Returns immediately if and when
/// the StaticVec reaches maximum capacity, regardless of whether or not `replace_with` still has
/// more items to yield.
///
/// # Panics
///
/// Panics if the range's starting point is greater than the end point or if the end point is
/// greater than the length of the StaticVec.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = staticvec![1, 2, 3];
/// let new = [7, 8];
/// let u: StaticVec<u8, 2> = v.splice(..2, new.iter().copied()).collect();
/// assert_eq!(v, [7, 8, 3]);
/// assert_eq!(u, [1, 2]);
/// ```
#[inline]
pub fn splice<R: RangeBounds<usize>, I: IntoIterator<Item = T>>(
&mut self,
range: R,
replace_with: I,
) -> StaticVecSplice<T, I::IntoIter, N> {
let length = self.length;
let start = match range.start_bound() {
Included(&idx) => idx,
Excluded(&idx) => idx + 1,
Unbounded => 0,
};
let end = match range.end_bound() {
Included(&idx) => idx + 1,
Excluded(&idx) => idx,
Unbounded => length,
};
assert!(
start <= end && end <= length,
"Bounds check failure in `StaticVec::splice`!"
);
StaticVecSplice {
start,
end,
replace_with: replace_with.into_iter(),
vec: self,
}
}
/// Removes all elements in the StaticVec for which `filter` returns false.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = staticvec![1, 2, 3, 4, 5];
/// let keep = staticvec![false, true, true, false, true];
/// let mut i = 0;
/// v.retain(|_| (keep[i], i += 1).0);
/// assert_eq!(v, [2, 3, 5]);
/// ```
#[inline(always)]
pub fn retain<F: FnMut(&T) -> bool>(&mut self, mut filter: F) {
self.drain_filter(|val| !filter(val));
}
/// Shortens the StaticVec, keeping the first `length` elements and dropping the rest.
/// Does nothing if `length` is greater than or equal to the current length of the StaticVec.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = staticvec![1, 2, 3, 4, 5];
/// v.truncate(2);
/// assert_eq!(v, [1, 2]);
/// ```
#[inline(always)]
pub fn truncate(&mut self, length: usize) {
if length < self.length {
let old_length = self.length;
unsafe {
self.set_len(length);
ptr::drop_in_place(from_raw_parts_mut(
self.mut_ptr_at_unchecked(length),
old_length - length,
));
}
}
}
/// Splits one StaticVec into two at the given index, returning the second half without consuming
/// the first half. The original StaticVec will contain all elements within the exclusive range
/// `0..at`, and the new one will contain all elements within the exclusive range
/// `at..self.len()`. This function will panic if `at` is greater than `self.len()`.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v1 = staticvec![1, 2, 3];
/// let v2 = v1.split_off(1);
/// assert_eq!(v1, [1]);
/// assert_eq!(v2, [2, 3]);
/// ```
#[inline]
pub const fn split_off(&mut self, at: usize) -> Self {
let old_length = self.length;
assert!(
at <= old_length,
"Bounds check failure in `StaticVec::split_off`!"
);
let split_length = old_length - at;
Self {
data: unsafe {
self.set_len(at);
let mut split = Self::new_data_uninit();
self
.ptr_at_unchecked(at)
.copy_to_nonoverlapping(Self::first_ptr_mut(&mut split), split_length);
split
},
length: split_length,
}
}
/// Splits one StaticVec into two new ones at index `M` and returns them in a tuple, while
/// consuming the original. The first new one will contain all elements within the exclusive range
/// `0..M`, and the second new one will contain all elements within the exclusive range
/// `M..self.len()`. This function will panic if `M` is greater than `self.len()`.
///
/// # Example usage:
/// ```
/// # #![feature(box_syntax)]
/// # use staticvec::*;
/// let v1 = staticvec![box 1, box 2, box 3, box 4, box 5, box 6];
/// let t1 = v1.split_at::<0>();
/// assert_eq!(t1.0, []);
/// assert_eq!(t1.1, [box 1, box 2, box 3, box 4, box 5, box 6]);
/// let v2 = staticvec![box 1, box 2, box 3, box 4, box 5, box 6];
/// let t2 = v2.split_at::<2>();
/// assert_eq!(t2.0, [box 1, box 2]);
/// assert_eq!(t2.1, [box 3, box 4, box 5, box 6]);
/// let v3 = staticvec![box 1, box 2, box 3, box 4, box 5, box 6];
/// let t3 = v3.split_at::<6>();
/// assert_eq!(t3.0, [box 1, box 2, box 3, box 4, box 5, box 6]);
/// assert_eq!(t3.1, []);
#[inline]
pub const fn split_at<const M: usize>(self) -> (StaticVec<T, M>, StaticVec<T, { N - M }>) {
let old_length = self.length;
assert!(
M <= old_length,
"Bounds check failure in `StaticVec::split_at'!"
);
let mut left = MaybeUninit::<[T; M]>::uninit();
let mut right = MaybeUninit::<[T; N - M]>::uninit();
let self_ptr = self.as_ptr();
let left_ptr = StaticVec::first_ptr_mut(&mut left);
let right_ptr = StaticVec::first_ptr_mut(&mut right);
let right_length = old_length - M;
unsafe {
self_ptr.copy_to_nonoverlapping(left_ptr, M);
self_ptr
.add(M)
.copy_to_nonoverlapping(right_ptr, right_length);
mem::forget(self);
(
StaticVec {
data: left,
length: M,
},
StaticVec {
data: right,
length: right_length,
},
)
}
}
/// Removes all but the first of consecutive elements in the StaticVec satisfying a given equality
/// relation.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = staticvec!["aaa", "bbb", "BBB", "ccc", "ddd"];
/// v.dedup_by(|a, b| a.eq_ignore_ascii_case(b));
/// assert_eq!(v, ["aaa", "bbb", "ccc", "ddd"]);
/// ```
#[inline(always)]
pub fn dedup_by<F: FnMut(&mut T, &mut T) -> bool>(&mut self, same_bucket: F) {
// Mostly the same as Vec's version.
let new_length = self.as_mut_slice().partition_dedup_by(same_bucket).0.len();
self.truncate(new_length);
}
/// Removes consecutive repeated elements in the StaticVec according to the
/// locally required [`PartialEq`](core::cmp::PartialEq) trait implementation for `T`.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = staticvec![1, 2, 2, 3, 2];
/// v.dedup();
/// assert_eq!(v, [1, 2, 3, 2]);
/// ```
#[inline(always)]
pub fn dedup(&mut self)
where T: PartialEq {
// Exactly the same as Vec's version.
self.dedup_by(|a, b| a == b)
}
/// Removes all but the first of consecutive elements in the StaticVec that
/// resolve to the same key.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// let mut v = staticvec![10, 20, 21, 30, 20];
/// v.dedup_by_key(|i| *i / 10);
/// assert_eq!(v, [10, 20, 30, 20]);
/// ```
#[inline(always)]
pub fn dedup_by_key<F: FnMut(&mut T) -> K, K: PartialEq<K>>(&mut self, mut key: F) {
// Exactly the same as Vec's version.
self.dedup_by(|a, b| key(a) == key(b))
}
/// Returns a new StaticVec representing the difference of `self` and `other` (that is,
/// all items present in `self`, but *not* present in `other`.)
///
/// The `N2` parameter does not need to be provided explicitly, and can be inferred from `other`
/// itself.
///
/// Locally requires that `T` implements [`Clone`](core::clone::Clone) to avoid soundness issues
/// while accommodating for more types than [`Copy`](core::marker::Copy) would appropriately for
/// this function, and [`PartialEq`](core::cmp::PartialEq) to make the item comparisons possible.
///
/// # Example usage:
/// ```
/// # use staticvec::staticvec;
/// assert_eq!(
/// staticvec![4, 5, 6, 7].difference(&staticvec![1, 2, 3, 7]),
/// [4, 5, 6]
/// );
/// ```
#[inline]
pub fn difference<const N2: usize>(&self, other: &StaticVec<T, N2>) -> Self
where T: Clone + PartialEq {
let mut res = Self::new();
for left in self {
let mut found = false;
for right in other {
if left == right {
found = true;
break;
}
}
if !found {
unsafe { res.push_unchecked(left.clone()) }
}
}
res
}
/// Returns a new StaticVec representing the symmetric difference of `self` and `other` (that is,
/// all items present in at least one of `self` or `other`, but *not* present in both.)
///
/// The `N2` parameter does not need to be provided explicitly, and can be inferred from `other`
/// itself.
///
/// Locally requires that `T` implements [`Clone`](core::clone::Clone) to avoid soundness issues
/// while accommodating for more types than [`Copy`](core::marker::Copy) would appropriately for
/// this function, and [`PartialEq`](core::cmp::PartialEq) to make the item comparisons possible.
///
/// # Example usage:
/// ```
/// # use staticvec::staticvec;
/// assert_eq!(
/// staticvec![1, 2, 3].symmetric_difference(&staticvec![3, 4, 5]),
/// [1, 2, 4, 5]
/// );
/// ```
#[inline]
pub fn symmetric_difference<const N2: usize>(
&self,
other: &StaticVec<T, N2>,
) -> StaticVec<T, { N + N2 }>
where
T: Clone + PartialEq,
{
let mut res = StaticVec::new();
for left in self {
let mut found = false;
for right in other {
if left == right {
found = true;
break;
}
}
if !found {
unsafe { res.push_unchecked(left.clone()) }
}
}
for right in other {
let mut found = false;
for left in self {
if right == left {
found = true;
break;
}
}
if !found {
unsafe { res.push_unchecked(right.clone()) }
}
}
res
}
/// Returns a new StaticVec representing the intersection of `self` and `other` (that is,
/// all items present in both `self` and `other`.)
///
/// The `N2` parameter does not need to be provided explicitly, and can be inferred from `other`
/// itself.
///
/// Locally requires that `T` implements [`Clone`](core::clone::Clone) to avoid soundness issues
/// while accommodating for more types than [`Copy`](core::marker::Copy) would appropriately for
/// this function, and [`PartialEq`](core::cmp::PartialEq) to make the item comparisons possible.
///
/// # Example usage:
/// ```
/// # use staticvec::staticvec;
/// assert_eq!(
/// staticvec![4, 5, 6, 7].intersection(&staticvec![1, 2, 3, 7, 4]),
/// [4, 7],
/// );
/// ```
#[inline]
pub fn intersection<const N2: usize>(&self, other: &StaticVec<T, N2>) -> Self
where T: Clone + PartialEq {
let mut res = Self::new();
for left in self {
let mut found = false;
for right in other {
if left == right {
found = true;
break;
}
}
if found && !res.contains(left) {
unsafe { res.push_unchecked(left.clone()) }
}
}
res
}
/// Returns a new StaticVec representing the union of `self` and `other` (that is, the full
/// contents of both `self` and `other`, minus any duplicates.)
///
/// The `N2` parameter does not need to be provided explicitly, and can be inferred from `other`
/// itself.
///
/// Locally requires that `T` implements [`Clone`](core::clone::Clone) to avoid soundness issues
/// while accommodating for more types than [`Copy`](core::marker::Copy) would appropriately for
/// this function, and [`PartialEq`](core::cmp::PartialEq) to make the item comparisons possible.
///
/// # Example usage:
/// ```
/// # use staticvec::staticvec;
/// assert_eq!(
/// staticvec![1, 2, 3].union(&staticvec![4, 2, 3, 4]),
/// [1, 2, 3, 4],
/// );
/// ```
#[allow(clippy::from_iter_instead_of_collect)]
#[inline]
#[rustfmt::skip]
pub fn union<const N2: usize>(&self, other: &StaticVec<T, N2>) -> StaticVec<T, { N + N2 }>
where T: Clone + PartialEq {
if self.length <= other.length {
let mut res = StaticVec::from_iter(self.iter().chain(other.difference(self).iter()).cloned());
res.dedup();
res
} else {
let mut res = StaticVec::from_iter(other.iter().chain(self.difference(other).iter()).cloned());
res.dedup();
res
}
}
/// A concept borrowed from the widely-used `SmallVec` crate, this function
/// returns a tuple consisting of a constant pointer to the first element of the StaticVec,
/// the length of the StaticVec, and the capacity of the StaticVec.
///
/// # Example usage:
/// ```
/// # use staticvec::*;
/// static V: StaticVec<usize, 4> = staticvec![4, 5, 6, 7];
/// assert_eq!(V.triple(), (V.as_ptr(), 4, 4));
/// ```
#[inline(always)]
pub const fn triple(&self) -> (*const T, usize, usize) {
(self.as_ptr(), self.length, N)
}
/// A mutable version of [`triple`](crate::StaticVec::triple). This implementation differs from
/// the one found in `SmallVec` in that it only provides the first element of the StaticVec as
/// a mutable pointer, not also the length as a mutable reference.
///
/// Example:
/// ```
/// # use::staticvec::*;
/// let mut v = staticvec![4, 5, 6, 7];
/// let mp = v.as_mut_ptr();
/// let t = v.triple_mut();
/// assert_eq!(t, (mp, 4, 4));
/// unsafe { *t.0 = 8 };
/// assert_eq!(v, [8, 5, 6, 7]);
/// ```
#[inline(always)]
pub const fn triple_mut(&mut self) -> (*mut T, usize, usize) {
(self.as_mut_ptr(), self.length, N)
}
/// Linearly adds (in a mathematical sense) the contents of two same-capacity
/// StaticVecs and returns the results in a new one of equal capacity.
///
/// Locally requires that `T` implements [`Copy`](core::marker::Copy) to allow
/// for an efficient implementation, and [`Add`](core::ops::Add) to make it possible
/// to add the elements.
///
/// For both performance and safety reasons, this function requires that both `self`
/// and `other` are at full capacity, and will panic if that is not the case (that is,
/// if `self.is_full() && other.is_full()` is not equal to `true`.)
///
/// # Example usage:
/// ```
/// # use staticvec::{staticvec, StaticVec};
/// const A: StaticVec<f64, 4> = staticvec![4.0, 5.0, 6.0, 7.0];
/// const B: StaticVec<f64, 4> = staticvec![2.0, 3.0, 4.0, 5.0];
/// assert_eq!(A.added(&B), [6.0, 8.0, 10.0, 12.0]);
/// ```
#[inline(always)]
pub fn added(&self, other: &Self) -> Self
where T: Copy + Add<Output = T> {
assert!(
self.is_full() && other.is_full(),
"In `StaticVec::added`, both `self` and `other` must be at maximum capacity!"
);
let mut res = Self::new();
for i in 0..N {
unsafe {
res
.mut_ptr_at_unchecked(i)
.write(*self.get_unchecked(i) + *other.get_unchecked(i));
}
}
res.length = N;
res
}
/// Linearly subtracts (in a mathematical sense) the contents of two same-capacity
/// StaticVecs and returns the results in a new one of equal capacity.
///
/// Locally requires that `T` implements [`Copy`](core::marker::Copy) to allow
/// for an efficient implementation, and [`Sub`](core::ops::Sub) to make it possible
/// to subtract the elements.
///
/// For both performance and safety reasons, this function requires that both `self`
/// and `other` are at full capacity, and will panic if that is not the case (that is,
/// if `self.is_full() && other.is_full()` is not equal to `true`.)
///
/// # Example usage:
/// ```
/// # use staticvec::{staticvec, StaticVec};
/// const A: StaticVec<f64, 4> = staticvec![4.0, 5.0, 6.0, 7.0];
/// const B: StaticVec<f64, 4> = staticvec![2.0, 3.0, 4.0, 5.0];
/// assert_eq!(A.subtracted(&B), [2.0, 2.0, 2.0, 2.0]);
/// ```
#[inline(always)]
pub fn subtracted(&self, other: &Self) -> Self
where T: Copy + Sub<Output = T> {
assert!(
self.is_full() && other.is_full(),
"In `StaticVec::subtracted`, both `self` and `other` must be at maximum capacity!"
);
let mut res = Self::new();
for i in 0..N {
unsafe {
res
.mut_ptr_at_unchecked(i)
.write(*self.get_unchecked(i) - *other.get_unchecked(i));
}
}
res.length = N;
res
}
/// Linearly multiplies (in a mathematical sense) the contents of two same-capacity
/// StaticVecs and returns the results in a new one of equal capacity.
///
/// Locally requires that `T` implements [`Copy`](core::marker::Copy) to allow
/// for an efficient implementation, and [`Mul`](core::ops::Mul) to make it possible
/// to multiply the elements.
///
/// For both performance and safety reasons, this function requires that both `self`
/// and `other` are at full capacity, and will panic if that is not the case (that is,
/// if `self.is_full() && other.is_full()` is not equal to `true`.)
///
/// # Example usage:
/// ```
/// # use staticvec::{staticvec, StaticVec};
/// const A: StaticVec<f64, 4> = staticvec![4.0, 5.0, 6.0, 7.0];
/// const B: StaticVec<f64, 4> = staticvec![2.0, 3.0, 4.0, 5.0];
/// assert_eq!(A.multiplied(&B), [8.0, 15.0, 24.0, 35.0]);
/// ```
#[inline(always)]
pub fn multiplied(&self, other: &Self) -> Self
where T: Copy + Mul<Output = T> {
assert!(
self.is_full() && other.is_full(),
"In `StaticVec::multiplied`, both `self` and `other` must be at maximum capacity!"
);
let mut res = Self::new();
for i in 0..N {
unsafe {
res
.mut_ptr_at_unchecked(i)
.write(*self.get_unchecked(i) * *other.get_unchecked(i));
}
}
res.length = N;
res
}
/// Linearly divides (in a mathematical sense) the contents of two same-capacity
/// StaticVecs and returns the results in a new one of equal capacity.
///
/// Locally requires that `T` implements [`Copy`](core::marker::Copy) to allow
/// for an efficient implementation, and [`Div`](core::ops::Div) to make it possible
/// to divide the elements.
///
/// For both performance and safety reasons, this function requires that both `self`
/// and `other` are at full capacity, and will panic if that is not the case (that is,
/// if `self.is_full() && other.is_full()` is not equal to `true`.)
///
/// # Example usage:
/// ```
/// # use staticvec::{staticvec, StaticVec};
/// const A: StaticVec<f64, 4> = staticvec![4.0, 5.0, 6.0, 7.0];
/// const B: StaticVec<f64, 4> = staticvec![2.0, 3.0, 4.0, 5.0];
/// assert_eq!(A.divided(&B), [2.0, 1.6666666666666667, 1.5, 1.4]);
/// ```
#[inline(always)]
pub fn divided(&self, other: &Self) -> Self
where T: Copy + Div<Output = T> {
assert!(
self.is_full() && other.is_full(),
"In `StaticVec::divided`, both `self` and `other` must be at maximum capacity!"
);
let mut res = Self::new();
for i in 0..N {
unsafe {
res
.mut_ptr_at_unchecked(i)
.write(*self.get_unchecked(i) / *other.get_unchecked(i));
}
}
res.length = N;
res
}
/// An internal convenience function to get an *uninitialized* instance of
/// `MaybeUninit<[T; N]>`.
#[inline(always)]
pub(crate) const fn new_data_uninit() -> MaybeUninit<[T; N]> {
MaybeUninit::uninit()
}
/// An internal convenience function to go from `&MaybeUninit<[T; N]>` to `*const T`.
/// Similar to [`MaybeUninit::first_ptr`](core::mem::MaybeUninit::first_ptr), but for arrays
/// as opposed to slices.
#[inline(always)]
pub(crate) const fn first_ptr(this: &MaybeUninit<[T; N]>) -> *const T {
let res = this.as_ptr() as *const T;
unsafe {
assume(!res.is_null());
}
res
}
/// An internal convenience function to go from `&mut MaybeUninit<[T; N]>` to `*mut T`.
/// Similar to [`MaybeUninit::first_ptr_mut`](core::mem::MaybeUninit::first_ptr_mut), but for
/// arrays as opposed to slices.
#[inline(always)]
pub(crate) const fn first_ptr_mut(this: &mut MaybeUninit<[T; N]>) -> *mut T {
let res = this.as_mut_ptr() as *mut T;
unsafe {
assume(!res.is_null());
}
res
}
}
impl<const N: usize> StaticVec<u8, N> {
/// Called solely in `__new_from_const_str`, where the input `MaybeUninit` is guaranteed to have
/// been properly initialized starting at the beginning with the bytes of an `&str` literal,
/// and the input `length` is the known-at-compile-time length of said literal.
#[doc(hidden)]
#[inline(always)]
pub(crate) const fn new_from_str_data(data: MaybeUninit<[u8; N]>, length: usize) -> Self {
Self { data, length }
}
/// Called solely in `__new_from_const_str`, where `values` is guaranteed to be the slice
/// representation of a proper `&str` literal.
#[doc(hidden)]
#[inline]
pub(crate) const fn bytes_to_data(values: &[u8]) -> MaybeUninit<[u8; N]> {
// Get an uninitialized array of bytes, with `N` capacity.
let mut res = MaybeUninit::uninit_array::<N>();
// Move `values.len()` worth of bytes from `values` to `res`. I'm unaware of any other way that
// this could be done currently that would leave us with something usable to create a StaticVec
// for which the generic `N` could be *different* from `values.len()`, so thank
// you, `const_loop`!
let mut i = 0;
while i < values.len() {
// We've statically asserted that `values.len() <= N` before entering this overall function,
// so there's no concern that we might go out of bounds here (although that would still just
// result in compilation not actually succeeding at all due to the `const` index error).
res[i] = MaybeUninit::new(values[i]);
i += 1;
}
// Fill in any remaining "gaps", or do nothing if `values.len()` is the same as `N`.
let mut i = values.len();
while i < N {
res[i] = MaybeUninit::zeroed();
i += 1;
}
// Convert `res` from an instance of `[MaybeUninit<u8>; N]` to one of `[u8; N]`, and then return
// it as an instance of `MaybeUninit<[u8; N]>` that can be used to construct a `StaticVec`.
MaybeUninit::new(unsafe { MaybeUninit::array_assume_init(res) })
}
/// Called solely from inside the `staticstring!` macro, and so must be public. This is guaranteed
/// to return a correctly initialized `StaticVec<u8, N>`, but we give it the two-underscore
/// prefix and hide it from `rustdoc` anyways just so no one thinks it's for general use.
#[doc(hidden)]
#[inline(always)]
pub const fn __new_from_const_str(values: &str) -> Self {
// This works at compile time too, of course, thanks to the `const_panic` feature.
assert!(
values.len() <= N,
"Attempted to create a `StaticString` with insufficient capacity from an `&str` literal!"
);
Self::new_from_str_data(Self::bytes_to_data(values.as_bytes()), values.len())
}
}