zng_var/lib.rs
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993 1994 1995 1996 1997 1998 1999 2000 2001 2002 2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013 2014 2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034 2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117 2118 2119 2120 2121 2122 2123 2124 2125 2126 2127 2128 2129 2130 2131 2132 2133 2134 2135 2136 2137 2138 2139 2140 2141 2142 2143 2144 2145 2146 2147 2148 2149 2150 2151 2152 2153 2154 2155 2156 2157 2158 2159 2160 2161 2162 2163 2164 2165 2166 2167 2168 2169 2170 2171 2172 2173 2174 2175 2176 2177 2178 2179 2180 2181 2182 2183 2184 2185 2186 2187 2188 2189 2190 2191 2192 2193 2194 2195 2196 2197 2198 2199 2200 2201 2202 2203 2204 2205 2206 2207 2208 2209 2210 2211 2212 2213 2214 2215 2216 2217 2218 2219 2220 2221 2222 2223 2224 2225 2226 2227 2228 2229 2230 2231 2232 2233 2234 2235 2236 2237 2238 2239 2240 2241 2242 2243 2244 2245 2246 2247 2248 2249 2250 2251 2252 2253 2254 2255 2256 2257 2258 2259 2260 2261 2262 2263 2264 2265 2266 2267 2268 2269 2270 2271 2272 2273 2274 2275 2276 2277 2278 2279 2280 2281 2282 2283 2284 2285 2286 2287 2288 2289 2290 2291 2292 2293 2294 2295 2296 2297 2298 2299 2300 2301 2302 2303 2304 2305 2306 2307 2308 2309 2310 2311 2312 2313 2314 2315 2316 2317 2318 2319 2320 2321 2322 2323 2324 2325 2326 2327 2328 2329 2330 2331 2332 2333 2334 2335 2336 2337 2338 2339 2340 2341 2342 2343 2344 2345 2346 2347 2348 2349 2350 2351 2352 2353 2354 2355 2356 2357 2358 2359 2360 2361 2362 2363 2364 2365 2366 2367 2368 2369 2370 2371 2372 2373 2374 2375 2376 2377 2378 2379 2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396 2397 2398 2399 2400 2401 2402 2403 2404 2405 2406 2407 2408 2409 2410 2411 2412 2413 2414 2415 2416 2417 2418 2419 2420 2421 2422 2423 2424 2425 2426 2427 2428 2429 2430 2431 2432 2433 2434 2435 2436 2437 2438 2439 2440 2441 2442 2443 2444 2445 2446 2447 2448 2449 2450 2451 2452 2453 2454 2455 2456 2457 2458 2459 2460 2461 2462 2463 2464 2465 2466 2467 2468 2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485 2486 2487 2488 2489 2490 2491 2492 2493 2494 2495 2496 2497 2498 2499 2500 2501 2502 2503 2504 2505 2506 2507 2508 2509 2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526 2527 2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541 2542 2543 2544 2545 2546 2547 2548 2549 2550 2551 2552 2553 2554 2555 2556 2557 2558 2559 2560 2561 2562 2563 2564 2565 2566 2567 2568 2569 2570 2571 2572 2573 2574 2575 2576 2577 2578 2579 2580 2581 2582 2583 2584 2585 2586 2587 2588 2589 2590 2591 2592 2593 2594 2595 2596 2597 2598 2599 2600 2601 2602 2603 2604 2605 2606 2607 2608 2609 2610 2611 2612 2613 2614 2615 2616 2617 2618 2619 2620 2621 2622 2623 2624 2625 2626 2627 2628 2629 2630 2631 2632 2633 2634 2635 2636 2637 2638 2639 2640 2641 2642 2643 2644 2645 2646 2647 2648 2649 2650 2651 2652 2653 2654 2655 2656 2657 2658 2659 2660 2661 2662 2663 2664 2665 2666 2667 2668 2669 2670 2671 2672 2673 2674 2675 2676 2677 2678 2679 2680 2681 2682 2683 2684 2685 2686 2687 2688 2689 2690 2691 2692 2693 2694 2695 2696 2697 2698 2699 2700 2701 2702 2703 2704 2705 2706 2707 2708 2709 2710 2711 2712 2713 2714 2715 2716 2717 2718 2719 2720 2721 2722 2723 2724 2725 2726 2727 2728 2729 2730 2731 2732 2733 2734 2735 2736 2737 2738 2739 2740 2741 2742 2743 2744 2745 2746 2747 2748 2749 2750 2751 2752 2753 2754 2755 2756 2757 2758 2759 2760 2761 2762 2763 2764 2765 2766 2767 2768 2769 2770 2771 2772 2773 2774 2775 2776 2777 2778 2779 2780 2781 2782 2783 2784 2785 2786 2787 2788 2789 2790 2791 2792 2793 2794 2795 2796 2797 2798 2799 2800 2801 2802 2803 2804 2805 2806 2807 2808 2809 2810 2811 2812 2813 2814 2815 2816 2817 2818 2819 2820 2821 2822 2823 2824 2825 2826 2827 2828 2829 2830 2831 2832 2833 2834 2835 2836 2837 2838 2839 2840 2841 2842 2843 2844 2845 2846 2847 2848 2849 2850 2851 2852 2853 2854 2855 2856 2857 2858 2859 2860 2861 2862 2863 2864 2865 2866 2867 2868 2869 2870 2871 2872 2873
#![doc(html_favicon_url = "https://raw.githubusercontent.com/zng-ui/zng/main/examples/image/res/zng-logo-icon.png")]
#![doc(html_logo_url = "https://raw.githubusercontent.com/zng-ui/zng/main/examples/image/res/zng-logo.png")]
//!
//! Batch updated variables in an app context.
//!
//! # Crate
//!
#![doc = include_str!(concat!("../", std::env!("CARGO_PKG_README")))]
// suppress nag about very simple boxed closure signatures.
#![expect(clippy::type_complexity)]
#![warn(unused_extern_crates)]
#![warn(missing_docs)]
#![deny(clippy::future_not_send)]
use animation::{
easing::{EasingStep, EasingTime},
Transitionable,
};
use bitflags::bitflags;
use parking_lot::Mutex;
use std::{
any::{Any, TypeId},
borrow::Cow,
fmt,
future::Future,
marker::PhantomData,
ops,
sync::{
atomic::{AtomicBool, Ordering::Relaxed},
Arc,
},
time::Duration,
};
use zng_app_context::{AppLocalId, ContextLocal};
use zng_clone_move::clmv;
use zng_txt::{formatx, ToTxt, Txt};
use zng_unit::{Factor, FactorUnits};
pub mod animation;
mod arc;
mod boxed;
mod impls;
mod context;
mod contextualized;
mod cow;
mod expr;
mod flat_map;
mod future;
mod local;
mod map_ref;
mod merge;
mod read_only;
mod response;
mod vars;
mod vec;
mod when;
#[macro_use]
mod util;
pub use arc::{getter_var, state_var, var, var_default, var_from, ArcVar};
pub use boxed::{BoxedAnyVar, BoxedAnyWeakVar, BoxedVar, BoxedWeakVar};
#[doc(inline)]
pub use context::{ContextInitHandle, ContextVar, ReadOnlyContextVar};
pub use local::LocalVar;
#[doc(inline)]
pub use merge::MergeVarBuilder;
pub use read_only::ReadOnlyArcVar;
pub use response::{response_done_var, response_var, ResponderVar, ResponseVar};
pub use vars::*;
pub use vec::ObservableVec;
/// Other variable types.
pub mod types {
use std::marker::PhantomData;
#[doc(hidden)]
pub use zng_app_context::context_local;
pub use impls::*;
pub use super::arc::WeakArcVar;
pub use super::boxed::{VarBoxed, WeakVarBoxed};
pub use super::context::{context_var_init, WeakContextInitHandle};
pub use super::contextualized::{ContextualizedVar, WeakContextualizedVar};
pub use super::cow::{ArcCowVar, WeakCowVar};
pub use super::expr::{__expr_var, expr_var_as, expr_var_into, expr_var_map};
pub use super::flat_map::{ArcFlatMapVar, WeakFlatMapVar};
pub use super::map_ref::{MapRef, MapRefBidi, WeakMapRef, WeakMapRefBidi};
pub use super::merge::{ArcMergeVar, ArcMergeVarInput, MergeVarInputs, WeakMergeVar, __merge_var};
pub use super::read_only::{ReadOnlyVar, WeakReadOnlyVar};
pub use super::response::Response;
pub use super::vec::VecChange;
pub use super::when::{AnyWhenVarBuilder, ArcWhenVar, ContextualizedArcWhenVar, WeakWhenVar, WhenVarBuilder, __when_var};
use super::*;
/// Identifies the source variable in another variable a value update.
///
/// The [`Var::set_from`] and bidirectional map/binding methods use this tag to avoid an extra "map_back" caused by "map" itself.
///
/// The tag is only equal to the same variable.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub struct SourceVarTag(usize);
impl SourceVarTag {
/// Tag that identifies the `source` variable.
pub fn new(source: &impl AnyVar) -> Self {
SourceVarTag(source.var_ptr().raw_pointer() as _)
}
}
/// Helper type for debug printing [`Var<T>`].
///
/// You can use [`Var::debug`] to get an instance.
pub struct VarDebug<'a, T: VarValue, V: Var<T>> {
pub(super) var: &'a V,
pub(super) _t: PhantomData<fn() -> T>,
}
impl<T: VarValue, V: Var<T>> fmt::Debug for VarDebug<'_, T, V> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
self.var.with(|t| fmt::Debug::fmt(t, f))
}
}
/// Helper type for display printing [`Var<T>`].
///
/// You can use [`Var::display`] to get an instance.
pub struct VarDisplay<'a, T: VarValue + fmt::Display, V: Var<T>> {
pub(super) var: &'a V,
pub(super) _t: PhantomData<fn() -> T>,
}
impl<T: VarValue + fmt::Display, V: Var<T>> fmt::Display for VarDisplay<'_, T, V> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
self.var.with(|t| fmt::Display::fmt(t, f))
}
}
}
mod private {
// https://rust-lang.github.io/api-guidelines/future-proofing.html#sealed-traits-protect-against-downstream-implementations-c-sealed
pub trait Sealed {}
}
/// Represents a type that can be a [`Var<T>`] value.
///
/// # Trait Alias
///
/// This trait is used like a type alias for traits and is
/// already implemented for all types it applies to.
///
/// # Implementing
///
/// Types need to be `Debug + Clone + PartialEq + Send + Sync + Any` to auto-implement this trait,
/// if you want to place an external type in a variable and it does not implement all the traits
/// you may need to declare a *newtype* wrapper, if the external type is `Debug + Send + Sync + Any` at
/// least you can use the [`ArcEq<T>`] wrapper to quickly implement `Clone + PartialEq`, this is particularly
/// useful for error types in [`ResponseVar<Result<_, E>>`].
#[diagnostic::on_unimplemented(note = "`VarValue` is implemented for all `T: Debug + Clone + PartialEq + Any + Send + Sync`")]
pub trait VarValue: fmt::Debug + Clone + PartialEq + Any + Send + Sync {}
impl<T: fmt::Debug + Clone + PartialEq + Any + Send + Sync> VarValue for T {}
/// Trait implemented for all [`VarValue`] types.
pub trait AnyVarValue: fmt::Debug + Any + Send + Sync {
/// Access to `dyn Any` methods.
fn as_any(&self) -> &dyn Any;
/// Access to mut `dyn Any` methods.
fn as_any_mut(&mut self) -> &mut dyn Any;
/// Access to `Box<dyn Any>` methods.
fn into_any(self: Box<Self>) -> Box<dyn Any>;
/// Clone the value.
fn clone_boxed(&self) -> Box<dyn AnyVarValue>;
/// Clone the value into a new boxed [`LocalVar<Self>`].
fn clone_boxed_var(&self) -> BoxedAnyVar;
/// Gets if `self` equals `other`.
fn eq_any(&self, other: &dyn AnyVarValue) -> bool;
}
impl<T: VarValue> AnyVarValue for T {
fn as_any(&self) -> &dyn Any {
self
}
fn as_any_mut(&mut self) -> &mut dyn Any {
self
}
fn clone_boxed(&self) -> Box<dyn AnyVarValue> {
Box::new(self.clone())
}
fn clone_boxed_var(&self) -> BoxedAnyVar {
Box::new(LocalVar(self.clone()))
}
fn into_any(self: Box<Self>) -> Box<dyn Any> {
self
}
fn eq_any(&self, other: &dyn AnyVarValue) -> bool {
match other.as_any().downcast_ref::<T>() {
Some(v) => self == v,
None => false,
}
}
}
/// A property value that is not a variable but can be inspected.
///
/// # Implementing
///
/// The trait is only auto-implemented for `T: Into<T> + VarValue`, unfortunately actual type conversions
/// must be manually implemented, note that the [`impl_from_and_into_var!`] macro auto-implements this conversion.
///
/// [inspected]: crate::inspector
/// [`Debug`]: std::fmt::Debug
/// [`impl_from_and_into_var`]: impl_from_and_into_var
#[diagnostic::on_unimplemented(
note = "`IntoValue<T>` is implemented for all `T: VarValue`",
note = "you can use `impl_from_and_into_var!` to implement conversions"
)]
pub trait IntoValue<T: VarValue>: Into<T> {}
impl<T: VarValue> IntoValue<T> for T {}
bitflags! {
/// Kinds of interactions allowed by a [`Var<T>`] in the current update.
///
/// You can get the current capabilities of a var by using the [`AnyVar::capabilities`] method.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct VarCapability: u8 {
/// Var value can change.
///
/// If this is set the [`AnyVar::is_new`] can be `true` in some updates, a variable can `NEW`
/// even if it cannot `MODIFY`, in this case the variable is a read-only wrapper on a read-write variable.
const NEW = 0b0000_0010;
/// Var can be modified.
///
/// If this is set [`Var::modify`] always returns `Ok`, if this is set `NEW` is also set.
///
/// Note that modify requests from inside overridden animations can still be ignored, see [`AnyVar::modify_importance`].
const MODIFY = 0b0000_0011;
/// Var capabilities can change.
///
/// Var capabilities can only change in between app updates, just like the var value, but [`AnyVar::last_update`]
/// may not change when capability changes.
const CAPS_CHANGE = 0b1000_0000;
}
}
impl VarCapability {
/// Remove only the `MODIFY` flag without removing `NEW`.
pub fn as_read_only(self) -> Self {
Self::from_bits_truncate(self.bits() & 0b1111_1110)
}
/// If cannot `MODIFY` and is not `CAPS_CHANGE`.
pub fn is_always_read_only(self) -> bool {
!self.contains(Self::MODIFY) && !self.contains(Self::CAPS_CHANGE)
}
/// If cannot `NEW` and is not `CAPS_CHANGE`.
pub fn is_always_static(self) -> bool {
self.is_empty()
}
/// Has the `MODIFY` capability.
pub fn can_modify(self) -> bool {
self.contains(Self::MODIFY)
}
}
/// Error when an attempt to modify a variable without the [`MODIFY`] capability is made.
///
/// [`MODIFY`]: VarCapability::MODIFY
#[derive(Debug, Clone, Copy)]
pub struct VarIsReadOnlyError {
/// Variable capabilities when the request was made.
pub capabilities: VarCapability,
}
impl fmt::Display for VarIsReadOnlyError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "cannot modify variable")
}
}
impl std::error::Error for VarIsReadOnlyError {}
struct VarHandleData {
perm: AtomicBool,
action: Box<dyn Fn(&AnyVarHookArgs) -> bool + Send + Sync>,
}
/// Represents the var side of a [`VarHandle`].
struct VarHook(Arc<VarHandleData>);
impl VarHook {
/// Calls the handle action, returns `true` if the handle must be retained.
pub fn call(&self, args: &AnyVarHookArgs) -> bool {
self.is_alive() && (self.0.action)(args)
}
/// If the handle is still held or is permanent.
pub fn is_alive(&self) -> bool {
Arc::strong_count(&self.0) > 1 || self.0.perm.load(Relaxed)
}
}
/// Handle to a variable hook.
///
/// This can represent a widget subscriber, a var binding, var app handler or animation, dropping the handler stops
/// the behavior it represents.
#[derive(Clone)]
#[must_use = "var handle stops the behavior it represents on drop"]
pub struct VarHandle(Option<Arc<VarHandleData>>);
impl VarHandle {
/// New handle, the `action` depends on the behavior the handle represents.
fn new(action: Box<dyn Fn(&AnyVarHookArgs) -> bool + Send + Sync>) -> (VarHandle, VarHook) {
let c = Arc::new(VarHandleData {
perm: AtomicBool::new(false),
action,
});
(VarHandle(Some(c.clone())), VarHook(c))
}
/// Handle to no variable.
pub fn dummy() -> Self {
VarHandle(None)
}
/// Returns `true` if the handle is a [`dummy`].
///
/// [`dummy`]: VarHandle::dummy
pub fn is_dummy(&self) -> bool {
self.0.is_none()
}
/// Drop the handle without stopping the behavior it represents.
///
/// Note that the behavior can still be stopped by dropping the involved variables.
pub fn perm(self) {
if let Some(s) = &self.0 {
s.perm.store(true, Relaxed);
}
}
/// Create a [`VarHandles`] collection with `self` and `other`.
pub fn with(self, other: Self) -> VarHandles {
[self, other].into()
}
}
impl PartialEq for VarHandle {
fn eq(&self, other: &Self) -> bool {
match (&self.0, &other.0) {
(None, None) => true,
(None, Some(_)) | (Some(_), None) => false,
(Some(a), Some(b)) => Arc::ptr_eq(a, b),
}
}
}
impl Eq for VarHandle {}
impl std::hash::Hash for VarHandle {
fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
let i = match &self.0 {
Some(rc) => Arc::as_ptr(rc) as usize,
None => 0,
};
state.write_usize(i);
}
}
impl fmt::Debug for VarHandle {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let i = match &self.0 {
Some(rc) => Arc::as_ptr(rc) as usize,
None => 0,
};
f.debug_tuple("VarHandle").field(&i).finish()
}
}
impl Default for VarHandle {
fn default() -> Self {
Self::dummy()
}
}
/// Represents a collection of var handles.
#[must_use = "var handles stops the behavior they represents on drop"]
#[derive(Clone, Default)]
pub struct VarHandles(pub Vec<VarHandle>);
impl VarHandles {
/// Empty collection.
pub const fn dummy() -> Self {
VarHandles(vec![])
}
/// Returns `true` if empty or all handles are dummy.
pub fn is_dummy(&self) -> bool {
self.0.is_empty() || self.0.iter().all(VarHandle::is_dummy)
}
/// Drop all handles without stopping their behavior.
pub fn perm(self) {
for handle in self.0 {
handle.perm()
}
}
/// Add the `other` handle to the collection, if it is not dummy.
pub fn push(&mut self, other: VarHandle) -> &mut Self {
if !other.is_dummy() {
self.0.push(other);
}
self
}
/// Drop all handles.
pub fn clear(&mut self) {
self.0.clear()
}
}
impl FromIterator<VarHandle> for VarHandles {
fn from_iter<T: IntoIterator<Item = VarHandle>>(iter: T) -> Self {
VarHandles(iter.into_iter().filter(|h| !h.is_dummy()).collect())
}
}
impl<const N: usize> From<[VarHandle; N]> for VarHandles {
fn from(handles: [VarHandle; N]) -> Self {
handles.into_iter().collect()
}
}
impl Extend<VarHandle> for VarHandles {
fn extend<T: IntoIterator<Item = VarHandle>>(&mut self, iter: T) {
for handle in iter {
self.push(handle);
}
}
}
impl IntoIterator for VarHandles {
type Item = VarHandle;
type IntoIter = std::vec::IntoIter<VarHandle>;
fn into_iter(self) -> Self::IntoIter {
self.0.into_iter()
}
}
/// Arc value that implements equality by pointer comparison.
///
/// This type allows external types that are only `Debug + Send + Sync` to become
/// a full [`VarValue`] to be allowed as a variable value.
pub struct ArcEq<T: fmt::Debug + Send + Sync>(pub Arc<T>);
impl<T: fmt::Debug + Send + Sync> ops::Deref for ArcEq<T> {
type Target = Arc<T>;
fn deref(&self) -> &Self::Target {
&self.0
}
}
impl<T: fmt::Debug + Send + Sync> ArcEq<T> {
/// Constructs a new `ArcEq<T>`.
pub fn new(value: T) -> Self {
Self(Arc::new(value))
}
}
impl<T: fmt::Debug + Send + Sync> PartialEq for ArcEq<T> {
fn eq(&self, other: &Self) -> bool {
Arc::ptr_eq(&self.0, &other.0)
}
}
impl<T: fmt::Debug + Send + Sync> Eq for ArcEq<T> {}
impl<T: fmt::Debug + Send + Sync> Clone for ArcEq<T> {
fn clone(&self) -> Self {
Self(Arc::clone(&self.0))
}
}
impl<T: fmt::Debug + Send + Sync> fmt::Debug for ArcEq<T> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
fmt::Debug::fmt(&*self.0, f)
}
}
/// Methods of [`Var<T>`] that are object safe.
///
/// This trait is [sealed] and cannot be implemented for types outside of this crate.
///
/// [sealed]: https://rust-lang.github.io/api-guidelines/future-proofing.html#sealed-traits-protect-against-downstream-implementations-c-sealed
pub trait AnyVar: Any + Send + Sync + crate::private::Sealed {
/// Clone the variable into a type erased box.
///
/// This is never [`BoxedVar<T>`], that is not a double box.
fn clone_any(&self) -> BoxedAnyVar;
/// Access to `dyn Any` methods.
fn as_any(&self) -> &dyn Any;
/// Access to `dyn Any` methods, on the underlying variable type if boxed.
fn as_unboxed_any(&self) -> &dyn Any;
/// Access to `Box<dyn Any>` methods, with the [`BoxedVar<T>`] type.
///
/// This is a double-boxed to allow downcast to [`BoxedVar<T>`].
fn double_boxed_any(self: Box<Self>) -> Box<dyn Any>;
/// Gets the [`TypeId`] of `T` in `Var<T>`.
fn var_type_id(&self) -> TypeId;
/// Get a clone of the current value, with type erased.
fn get_any(&self) -> Box<dyn AnyVarValue>;
/// Visit the current value of the variable.
fn with_any(&self, read: &mut dyn FnMut(&dyn AnyVarValue));
/// Visit the current value of the variable, if it [`is_new`].
///
/// [`is_new`]: AnyVar::is_new
fn with_new_any(&self, read: &mut dyn FnMut(&dyn AnyVarValue)) -> bool;
/// Schedule a new `value` for the variable, it will be set in the end of the current app update.
///
/// # Panics
///
/// Panics if the `value` is not of the same [`var_type_id`].
///
/// [`var_type_id`]: AnyVar::var_type_id
fn set_any(&self, value: Box<dyn AnyVarValue>) -> Result<(), VarIsReadOnlyError>;
/// Last update ID a variable was modified, if the ID is equal to [`VARS.update_id`] the variable is *new*.
///
/// [`VARS.update_id`]: VARS::update_id
fn last_update(&self) -> VarUpdateId;
/// If the variable represents different values depending on the context where they are read.
fn is_contextual(&self) -> bool;
/// Flags that indicate what operations the variable is capable of in this update.
fn capabilities(&self) -> VarCapability;
/// Gets if the [`last_update`] is the current update, meaning the variable value just changed.
///
/// Note that this is only reliable in threads synchronized with the UI update, this status can change
/// at any time when called from other app threads.
///
/// [`last_update`]: AnyVar::last_update
fn is_new(&self) -> bool {
VARS.update_id() == self.last_update()
}
/// If the variable current value was set by an active animation.
///
/// The variable [`is_new`] when this changes to `true`, but it **may not be new** when the value changes to `false`.
/// If the variable is not updated at the last frame of the animation that has last set it, it will not update
/// just because that animation has ended. You can use [`hook_animation_stop`] to get a notification when the
/// last animation stops, or use [`wait_animation`] to get a future that is ready when `is_animating` changes
/// from `true` to `false`.
///
/// [`is_new`]: AnyVar::is_new
/// [`hook_animation_stop`]: AnyVar::hook_animation_stop
/// [`wait_animation`]: Var::wait_animation
fn is_animating(&self) -> bool;
/// Gets a value that indicates the *importance* clearance that is needed to modify this variable.
///
/// If the variable has the [`MODIFY`] capability, `modify` requests will return `Ok(())`, but they will be ignored
/// if the [`VARS.current_modify`] importance is less than the variable's at the moment the request is made.
///
/// Note that [`VARS.current_modify`] outside animations always overrides this value, so direct modify requests
/// always override running animations.
///
/// This is the mechanism that ensures that only the latest animation has *control* of the variable value, most animations
/// check this value and automatically cancel if overridden, but event assigns from custom animations made using [`VARS.animate`]
/// are ignored if the variable is modified from a newer source then the animation.
///
/// If the variable does not have [`MODIFY`] capability the value returned is undefined.
///
/// [`MODIFY`]: VarCapability::MODIFY
/// [`VARS.current_modify`]: VARS::current_modify
/// [`VARS.animate`]: VARS::animate
fn modify_importance(&self) -> usize;
/// Setups a callback for just after the variable value update is applied, the closure runs in the root app context, just like
/// the `modify` closure. The closure can return if it is retained after each call. If you modify another variable in a
/// hook the modification applies in the same update, variable mapping and binding is implemented using hooks.
///
/// The variable store a weak reference to the callback if it has the `MODIFY` or `CAPS_CHANGE` capabilities, otherwise
/// the callback is discarded and [`VarHandle::dummy`] returned.
fn hook_any(&self, pos_modify_action: Box<dyn Fn(&AnyVarHookArgs) -> bool + Send + Sync>) -> VarHandle;
/// Register a `handler` to be called when the current animation stops.
///
/// Note that the `handler` is owned by the animation, not the variable, it will only be called/dropped when the
/// animation stops.
///
/// Returns the `handler` as an error if the variable is not animating. Note that if you are interacting
/// with the variable from a non-UI thread the variable can stops animating between checking [`is_animating`]
/// and registering the hook, in this case the `handler` will be returned as an error as well.
///
/// [`modify_importance`]: AnyVar::modify_importance
/// [`is_animating`]: AnyVar::is_animating
fn hook_animation_stop(&self, handler: Box<dyn FnOnce() + Send>) -> Result<(), Box<dyn FnOnce() + Send>>;
/// Gets the number of strong references to the variable.
///
/// This is the [`Arc::strong_count`] for *Arc* variables, the context var count for [`ContextVar<T>`], the boxed var count
/// for [`BoxedVar<T>`] and `0` for [`LocalVar<T>`].
fn strong_count(&self) -> usize;
/// Gets the number of weak references to the variable.
///
/// This is the [`Arc::weak_count`] for *Arc* variables, the context var count for [`ContextVar<T>`], the boxed var count
/// for [`BoxedVar<T>`] and `0` for [`LocalVar<T>`].
fn weak_count(&self) -> usize;
/// Gets a clone of the represented var from [`ContextVar<T>`], gets a clone of `self` for other var types.
fn actual_var_any(&self) -> BoxedAnyVar;
/// Create a weak reference to this *Arc* variable.
///
/// The weak reference is made to the [`actual_var`], if the actual var is a [`LocalVar<T>`]
/// a [`types::WeakArcVar<T>`] is returned, for *Arc* vars an actual weak reference is made.
///
/// [`actual_var`]: Var::actual_var
fn downgrade_any(&self) -> BoxedAnyWeakVar;
/// Var *pointer*, that can be used to identify if two variables point to the same *rc* or *context*.
///
/// If two of these values are equal, both variables point to the same *rc* or *context* at the moment of comparison.
/// Note that this is only for comparison, trying to access the variable internals is never safe.
fn var_ptr(&self) -> VarPtr;
/// Get the value as a debug [`Txt`].
///
/// [`Txt`]: Txt
fn get_debug(&self) -> Txt;
/// Schedule a variable update, even if the value does no change.
///
/// Usually variables only notify update if the value is changed to a different one, calling
/// this method flags the variable to notify.
fn update(&self) -> Result<(), VarIsReadOnlyError>;
/// Create a [`map`] that converts from `T` to a [`Txt`] debug print.
///
/// [`map`]: Var::map
/// [`Txt`]: Txt
fn map_debug(&self) -> BoxedVar<Txt>;
/// Hold the variable in memory until the app exit.
fn perm(&self) {
VARS.perm(self.clone_any());
}
/// Keep `other` alive until the handle or `self` are dropped.
fn hold_any(&self, value: Box<dyn Any + Send + Sync>) -> VarHandle {
self.hook_any(Box::new(move |_| {
let _hold = &value;
true
}))
}
}
#[derive(Debug)]
enum VarPtrData {
Static(AppLocalId),
Arc(*const ()),
NeverEq,
}
impl PartialEq for VarPtrData {
fn eq(&self, other: &Self) -> bool {
match (self, other) {
(Self::Static(l0), Self::Static(r0)) => l0 == r0,
(Self::Arc(l0), Self::Arc(r0)) => l0 == r0,
_ => false,
}
}
}
/// Represents an [`AnyVar`] *pointer* that can be used for comparison.
///
/// If two of these values are equal, both variables point to the same *arc* or *context* at the moment of comparison.
pub struct VarPtr<'a> {
_lt: std::marker::PhantomData<&'a ()>,
eq: VarPtrData,
}
impl<'a> VarPtr<'a> {
/// Gets the pointer.
///
/// # Safety
///
/// Trying to read or write values using this pointer is **never safe**.
///
/// Trying to identify a variable using the raw pointer is only valid if you know the variable is still alive.
/// The variable could be dropped and new one allocated at the same address.
pub fn raw_pointer(&self) -> *const () {
match self.eq {
VarPtrData::Arc(p) => p,
VarPtrData::Static(p) => p.get() as *const (),
VarPtrData::NeverEq => std::ptr::null(),
}
}
fn new_arc<T: ?Sized>(rc: &'a Arc<T>) -> Self {
Self {
_lt: std::marker::PhantomData,
eq: VarPtrData::Arc(Arc::as_ptr(rc) as _),
}
}
fn new_ctx_local<T: Send + Sync>(tl: &'static ContextLocal<T>) -> Self {
Self {
_lt: std::marker::PhantomData,
eq: VarPtrData::Static(tl.id()),
}
}
fn new_never_eq(_: &'a impl Any) -> Self {
Self {
_lt: std::marker::PhantomData,
eq: VarPtrData::NeverEq,
}
}
}
impl PartialEq for VarPtr<'_> {
fn eq(&self, other: &Self) -> bool {
self.eq == other.eq
}
}
impl fmt::Debug for VarPtr<'_> {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
if f.alternate() {
f.debug_tuple("VarPtr").field(&self.eq).finish()
} else {
fmt::Debug::fmt(&self.eq, f)
}
}
}
/// Represents a weak reference to an [`AnyVar`].
pub trait AnyWeakVar: Any + Send + Sync + crate::private::Sealed {
/// Clone the weak reference.
fn clone_any(&self) -> BoxedAnyWeakVar;
/// Access to `dyn Any` methods.
fn as_any(&self) -> &dyn Any;
/// Gets the number of strong references to the variable.
///
/// This is the same as [`AnyVar::strong_count`].
fn strong_count(&self) -> usize;
/// Gets the number of weak references to the variable.
///
/// This is the same as [`AnyVar::weak_count`].
fn weak_count(&self) -> usize;
/// Upgrade to a strong [`AnyVar`] clone.
///
/// Returns `None` if the [`strong_count`] is zero.
///
/// [`strong_count`]: AnyWeakVar
fn upgrade_any(&self) -> Option<BoxedAnyVar>;
}
/// Represents a weak reference to a [`Var<T>`].
pub trait WeakVar<T: VarValue>: AnyWeakVar + Clone {
/// Output of [`WeakVar::upgrade`].
type Upgrade: Var<T>;
/// Upgrade to a strong [`BoxedVar<T>`] clone.
///
/// Returns `None` if the [`strong_count`] is zero.
///
/// [`strong_count`]: AnyWeakVar
fn upgrade(&self) -> Option<Self::Upgrade>;
/// Gets the weak reference a as [`BoxedWeakVar<T>`], does not double box.
fn boxed(self) -> BoxedWeakVar<T>
where
Self: Sized,
{
Box::new(self)
}
}
/// A value-to-var conversion that consumes the value.
///
/// Every [`Var<T>`] implements this to convert to itself, every [`VarValue`] implements this to
/// convert to a [`LocalVar<T>`].
///
/// This trait is used by most properties, it allows then to accept literal values, variables and context variables
/// all with a single signature. Together with [`Var<T>`] this gives properties great flexibility of usage, at zero-cost. Widget
/// `when` blocks also use [`IntoVar<T>`] to support *changing* the property value depending on the widget state.
///
/// Value types can also manually implement this to support a shorthand literal syntax for when they are used in properties,
/// this converts the *shorthand value* like a tuple into the actual value type and wraps it into a variable, usually [`LocalVar`]
/// too. They can implement the trait multiple times to support different shorthand syntaxes or different types in the shorthand
/// value.
#[diagnostic::on_unimplemented(
note = "`IntoVar<T>` is implemented for all `T: VarValue`",
note = "`IntoVar<T>` is implemented for all `V: Var<T>`"
)]
pub trait IntoVar<T: VarValue> {
/// Variable type that will wrap the `T` value.
///
/// This is the [`LocalVar`] for most types or `Self` for variable types.
type Var: Var<T>;
/// Converts the source value into a var.
fn into_var(self) -> Self::Var;
/// Converts into [`BoxedVar<T>`].
///
/// This method exists to help the type system infer the type in this scenario:
///
/// ```
/// # use zng_var::*;
/// # let bar = true;
/// # let BAR_VAR = var(true);
/// #
/// fn foo(foo: impl IntoVar<bool>) { }
///
/// foo(if bar {
/// BAR_VAR.map(|b| !*b).boxed()
/// } else {
/// true.into_boxed_var()
/// });
/// ```
///
/// We need a `BoxedVar<bool>` to unify the input types that can be a `map` var or a `LocalVar<bool>`. Writing `true.into_var().boxed()`
/// causes the type inference to fail, requiring us to write `IntoVar::<bool>::into_var(true).boxed()`.
fn into_boxed_var(self) -> BoxedVar<T>
where
Self: Sized,
{
self.into_var().boxed()
}
}
/// Represents the current value in a [`Var::modify`] handler.
pub struct VarModify<'a, T: VarValue> {
current_value: &'a T,
value: Cow<'a, T>,
update: bool,
tags: Vec<Box<dyn AnyVarValue>>,
custom_importance: Option<usize>,
}
impl<'a, T: VarValue> VarModify<'a, T> {
/// Replace the value.
///
/// The variable will update if the new value is not equal to the previous after all modify closures apply.
pub fn set(&mut self, new_value: T) {
self.value = Cow::Owned(new_value);
}
/// Notify an update, even if the value does not actually change.
pub fn update(&mut self) {
self.update = true;
}
/// Returns a mutable reference for modification.
///
/// Note that this clones the current value if this is the first modify closure requesting it.
///
/// The variable will update if the new value is not equal to the previous after all modify closures apply.
pub fn to_mut(&mut self) -> &mut T {
self.value.to_mut()
}
/// Custom tags that will be shared with the var hooks if the value updates.
///
/// The tags where set by previous modify closures or this one during this update cycle, so
/// tags can also be used to communicate between modify closures.
pub fn tags(&self) -> &[Box<dyn AnyVarValue>] {
&self.tags
}
/// Add a custom tag object that will be shared with the var hooks if the value updates.
pub fn push_tag(&mut self, tag: impl AnyVarValue) {
self.tags.push(Box::new(tag));
}
/// Add all custom tags.
pub fn push_tags(&mut self, tags: Vec<Box<dyn AnyVarValue>>) {
if self.tags.is_empty() {
self.tags = tags;
} else {
self.tags.extend(tags);
}
}
/// Sets a custom [`AnyVar::modify_importance`] value.
///
/// Note that the modify info is already automatically set, using a custom value here
/// can easily break all future modify requests for this variable. The importance is set even if the
/// variable does not update (no actual value change or update request).
pub fn set_modify_importance(&mut self, importance: usize) {
self.custom_importance = Some(importance);
}
/// New from current value.
pub fn new(current_value: &'a T) -> Self {
Self {
current_value,
value: Cow::Borrowed(current_value),
update: false,
tags: vec![],
custom_importance: None,
}
}
/// Returns `(notify, new_value, update, tags, custom_importance)`.
pub fn finish(self) -> (bool, Option<T>, bool, Vec<Box<dyn AnyVarValue>>, Option<usize>) {
match self.value {
Cow::Borrowed(_) => {
if self.update {
return (true, None, true, self.tags, self.custom_importance);
}
}
Cow::Owned(v) => {
if self.update || self.current_value != &v {
return (true, Some(v), self.update, self.tags, self.custom_importance);
}
}
}
(false, None, false, vec![], self.custom_importance)
}
}
impl<T: VarValue> ops::Deref for VarModify<'_, T> {
type Target = T;
fn deref(&self) -> &Self::Target {
self.as_ref()
}
}
impl<T: VarValue> std::convert::AsRef<T> for VarModify<'_, T> {
fn as_ref(&self) -> &T {
&self.value
}
}
/// Arguments for [`AnyVar::hook_any`].
pub struct AnyVarHookArgs<'a> {
value: &'a dyn AnyVarValue,
update: bool,
tags: &'a [Box<dyn AnyVarValue>],
}
impl<'a> AnyVarHookArgs<'a> {
/// New from updated value and custom tag.
pub fn new(value: &'a dyn AnyVarValue, update: bool, tags: &'a [Box<dyn AnyVarValue>]) -> Self {
Self { value, update, tags }
}
/// Reference the updated value.
pub fn value(&self) -> &'a dyn AnyVarValue {
self.value
}
/// If update was explicitly requested.
///
/// Note that bindings/mappings propagate this update request.
pub fn update(&self) -> bool {
self.update
}
/// Value type ID.
pub fn value_type(&self) -> TypeId {
self.value.as_any().type_id()
}
/// Custom tag objects.
pub fn tags(&self) -> &[Box<dyn AnyVarValue>] {
self.tags
}
/// Clone the custom tag objects set by the code that updated the value.
pub fn tags_vec(&self) -> Vec<Box<dyn AnyVarValue>> {
self.tags.iter().map(|t| (*t).clone_boxed()).collect()
}
/// Reference the value, if it is of type `T`.
pub fn downcast_value<T: VarValue>(&self) -> Option<&T> {
self.value.as_any().downcast_ref()
}
/// Reference all custom tag values of type `T`.
pub fn downcast_tags<T: VarValue>(&self) -> impl Iterator<Item = &T> + '_ {
self.tags.iter().filter_map(|t| (*t).as_any().downcast_ref::<T>())
}
/// Try cast to strongly typed args.
pub fn as_strong<T: VarValue>(&self) -> Option<VarHookArgs<T>> {
if TypeId::of::<T>() == self.value_type() {
Some(VarHookArgs {
any: self,
_t: PhantomData,
})
} else {
None
}
}
}
/// Arguments for [`Var::hook`].
pub struct VarHookArgs<'a, T: VarValue> {
any: &'a AnyVarHookArgs<'a>,
_t: PhantomData<&'a T>,
}
impl<'a, T: VarValue> VarHookArgs<'a, T> {
/// Reference the updated value.
pub fn value(&self) -> &'a T {
self.any.value.as_any().downcast_ref::<T>().unwrap()
}
}
impl<'a, T: VarValue> ops::Deref for VarHookArgs<'a, T> {
type Target = AnyVarHookArgs<'a>;
fn deref(&self) -> &Self::Target {
self.any
}
}
/// Args for [`Var::trace_value`].
pub struct TraceValueArgs<'a, T: VarValue> {
args: &'a AnyVarHookArgs<'a>,
_type: PhantomData<&'a T>,
}
impl<'a, T: VarValue> ops::Deref for TraceValueArgs<'a, T> {
type Target = AnyVarHookArgs<'a>;
fn deref(&self) -> &Self::Target {
self.args
}
}
impl<'a, T: VarValue> TraceValueArgs<'a, T> {
/// Strongly-typed reference to the new value.
pub fn value(&self) -> &'a T {
self.args.downcast_value::<T>().unwrap()
}
}
/// Represents an observable value.
///
/// Variable types can have different capabilities, all can provide a value, in some the value can update, some
/// are read-only others allow modifying the value. Variables can also be contextual, meaning they have a different
/// value depending on the context where they are used. This trait covers all these capabilities, together with
/// [`IntoVar<T>`] it enables properties to be very flexible on what input they accept.
///
/// See [`AnyVar`] for the object safe part of variables.
///
/// This trait is [sealed] and cannot be implemented for types outside of this crate.
///
/// [sealed]: https://rust-lang.github.io/api-guidelines/future-proofing.html#sealed-traits-protect-against-downstream-implementations-c-sealed
pub trait Var<T: VarValue>: IntoVar<T, Var = Self> + AnyVar + Clone {
/// Output of [`Var::read_only`].
type ReadOnly: Var<T>;
/// Output of [`Var::actual_var`].
type ActualVar: Var<T>;
/// Output of [`Var::downgrade`].
type Downgrade: WeakVar<T>;
/// Output of [`Var::map`].
type Map<O: VarValue>: Var<O>;
/// Output of [`Var::map_bidi`].
type MapBidi<O: VarValue>: Var<O>;
/// Output of [`Var::flat_map`].
type FlatMap<O: VarValue, V: Var<O>>: Var<O>;
/// Output of [`Var::filter_map`].
type FilterMap<O: VarValue>: Var<O>;
/// Output of [`Var::filter_map_bidi`].
type FilterMapBidi<O: VarValue>: Var<O>;
/// Output of [`Var::map_ref`].
type MapRef<O: VarValue>: Var<O>;
/// Output of [`Var::map_ref_bidi`].
type MapRefBidi<O: VarValue>: Var<O>;
/// Output of [`Var::easing`].
type Easing: Var<T>;
/// Visit the current value of the variable.
fn with<R, F>(&self, read: F) -> R
where
F: FnOnce(&T) -> R;
/// Schedule a variable update, it will be applied on the end of the current app update.
fn modify<F>(&self, modify: F) -> Result<(), VarIsReadOnlyError>
where
F: FnOnce(&mut VarModify<T>) + Send + 'static;
/// Gets the variable as a [`BoxedVar<T>`], does not double box.
fn boxed(self) -> BoxedVar<T>
where
Self: Sized,
{
Box::new(self)
}
/// Gets the variable as a [`BoxedAnyVar`], does not double box.
fn boxed_any(self) -> BoxedAnyVar
where
Self: Sized,
{
Box::new(self)
}
/// Gets the current *inner* var represented by this var. This can be the same var or a context var.
fn actual_var(self) -> Self::ActualVar;
/// Create a weak reference to this *Arc* variable.
fn downgrade(&self) -> Self::Downgrade;
/// Convert this variable to the value, if possible moves the value, if it is shared clones it.
fn into_value(self) -> T;
/// Gets a clone of the var that is always read-only.
///
/// The returned variable can still update if `self` is modified, but it does not have the `MODIFY` capability.
fn read_only(&self) -> Self::ReadOnly;
/// Setups a callback for just after the variable value update is applied, the closure runs in the root app context, just like
/// the `modify` closure. The closure can return if it is retained after each call. If you modify another variable in a
/// hook the modification applies in the same update, variable mapping and binding is implemented using hooks.
///
/// The variable store a weak reference to the callback if it has the `MODIFY` or `CAPS_CHANGE` capabilities, otherwise
/// the callback is discarded and [`VarHandle::dummy`] returned.
fn hook(&self, pos_modify_action: impl Fn(&VarHookArgs<T>) -> bool + Send + Sync + 'static) -> VarHandle {
self.hook_any(Box::new(move |a| pos_modify_action(&a.as_strong().unwrap())))
}
/// Awaits for the [`last_update`] to change.
///
/// Note that [`is_new`] will be `true` when the future elapses only when polled
/// in sync with the UI, but it will elapse in any thread when the variable updates after the future is instantiated.
///
/// Note that outside of the UI tree there is no variable synchronization across multiple var method calls, so
/// a sequence of `get(); wait_update().await; get();` can miss a value between `get` and `wait_update`. The returned
/// future captures the [`last_update`] at the moment this method is called, this can be leveraged by double-checking to
/// avoid race conditions, see the [`wait_value`] default implementation for more details.
///
/// [`get`]: Var::get
/// [`wait_value`]: Var::wait_value
/// [`last_update`]: AnyVar::last_update
/// [`is_new`]: AnyVar::is_new
fn wait_update(&self) -> impl Future<Output = VarUpdateId> + Send + Sync {
crate::future::WaitUpdateFut::new(self)
}
/// Awaits for [`is_animating`] to change from `true` to `false`.
///
/// If the variable is not animating at the moment of this call the future will await until the animation starts and stops.
///
/// [`is_animating`]: AnyVar::is_animating
fn wait_animation(&self) -> impl Future<Output = ()> + Send + Sync {
crate::future::WaitIsNotAnimatingFut::new(self)
}
///Awaits for a value that passes the `predicate`.
fn wait_value(&self, predicate: impl Fn(&T) -> bool + Send + Sync) -> impl Future<Output = ()> + Send + Sync {
async move {
while !self.with(&predicate) {
let future = self.wait_update();
if self.with(&predicate) {
break;
}
future.await;
}
}
}
/// Visit the current value of the variable, if it [`is_new`].
///
/// [`is_new`]: AnyVar::is_new
fn with_new<R, F>(&self, read: F) -> Option<R>
where
F: FnOnce(&T) -> R,
{
if self.is_new() {
Some(self.with(read))
} else {
None
}
}
/// Get a clone of the current value.
fn get(&self) -> T {
self.with(Clone::clone)
}
/// Gets the value as a display [`Txt`].
///
/// [`Txt`]: Txt
fn get_txt(&self) -> Txt
where
T: fmt::Display,
{
self.with(ToTxt::to_txt)
}
/// Gets the value as a display [`String`].
fn get_string(&self) -> String
where
T: fmt::Display,
{
self.with(ToString::to_string)
}
/// Get a clone of the current value into `value`.
fn get_into(&self, value: &mut T) {
self.with(var_get_into(value))
}
/// Get a clone of the current value into `value` if the current value is not equal to it.
fn get_ne(&self, value: &mut T) -> bool {
self.with(var_get_ne(value))
}
/// Get a clone of the current value, if it [`is_new`].
///
/// [`is_new`]: AnyVar::is_new
fn get_new(&self) -> Option<T> {
if self.is_new() {
Some(self.with(Clone::clone))
} else {
None
}
}
/// Get a clone of the current value into `value` if the current value [`is_new`].
///
/// [`is_new`]: AnyVar::is_new
fn get_new_into(&self, value: &mut T) -> bool {
let is_new = self.is_new();
if is_new {
self.with(var_get_into(value));
}
is_new
}
/// Get a clone of the current value into `value` if the variable value [`is_new`] and not equal to the `value`.
///
/// [`is_new`]: AnyVar::is_new
fn get_new_ne(&self, value: &mut T) -> bool {
self.is_new() && self.get_ne(value)
}
/// Schedule a new `value` for the variable, it will be set in the end of the current app update.
fn set<I>(&self, value: I) -> Result<(), VarIsReadOnlyError>
where
I: Into<T>,
{
self.modify(var_set(value.into()))
}
/// Schedule a new `value` for the variable, it will be set in the end of the current app update to the updated
/// value of `other`, so if the other var has already scheduled an update, the updated value will be used.
///
/// This can be used in combination with binding to create a binding that starts with synchronized values.
fn set_from<I>(&self, other: &I) -> Result<(), VarIsReadOnlyError>
where
I: Var<T>,
{
if other.capabilities().is_always_static() {
self.set(other.get())
} else {
self.modify(var_set_from(other.clone().actual_var()))
}
}
/// Set from `other` value at the time of update, mapped to the type of `self`.
fn set_from_map<Iv, I, M>(&self, other: &I, map: M) -> Result<(), VarIsReadOnlyError>
where
Iv: VarValue,
I: Var<Iv>,
M: FnOnce(&Iv) -> T + Send + 'static,
{
if other.capabilities().is_always_static() {
self.set(other.with(map))
} else {
self.modify(var_set_from_map(other.clone().actual_var(), map))
}
}
/// Create a var that redirects to this variable until the first value update, then it behaves like a [`ArcVar<T>`].
///
/// The return variable is *clone-on-write* and has the `MODIFY` capability independent of the source capabilities, when
/// a modify request is made the source value is cloned and offered for modification, if modified the source variable is dropped
/// and the cow var behaves like a [`ArcVar<T>`], if the modify closure does not update the cloned value it is dropped and the cow
/// continues to redirect to the source variable.
fn cow(&self) -> types::ArcCowVar<T, Self> {
types::ArcCowVar::new(self.clone())
}
/// Creates a var that maps from this variable.
///
/// The `map` closure is called once on initialization, and then once every time
/// the source variable updates.
///
/// The mapping variable is read-only, you can use [`map_bidi`] to map back.
///
/// Note that the mapping var can be [contextualized] for context vars, meaning the map binding will initialize in
/// the fist usage context, not the creation context, so `property = CONTEXT_VAR.map(|&b|!b);` will bind with
/// the `CONTEXT_VAR` in the `property` context, not the property instantiation. The `map` closure itself runs in
/// the root app context, trying to read other context variables inside it will only read the default value.
///
/// For other variables types the `map` can run once in the caller context.
///
/// If `self` can change the output variable will keep it alive, this is to support chaining maps.
///
/// [`map_bidi`]: Var::map_bidi
/// [contextualized]: types::ContextualizedVar
fn map<O, M>(&self, map: M) -> Self::Map<O>
where
O: VarValue,
M: FnMut(&T) -> O + Send + 'static;
/// Creates a [`map`] that converts from `T` to `O` using [`Into<O>`].
///
/// [`map`]: Var::map
fn map_into<O>(&self) -> Self::Map<O>
where
O: VarValue,
T: Into<O>,
{
self.map(|v| v.clone().into())
}
/// Creates a [`map`] that converts from `T` to [`Txt`] using [`ToTxt`].
///
/// [`map`]: Var::map
/// [`Txt`]: Txt
/// [`ToTxt`]: ToTxt
fn map_to_txt(&self) -> Self::Map<Txt>
where
T: ToTxt,
{
self.map(ToTxt::to_txt)
}
/// Create a [`map`] that converts from `T` to [`String`] using [`ToString`].
///
/// [`map`]: Var::map
fn map_to_string(&self) -> Self::Map<String>
where
T: ToString,
{
self.map(ToString::to_string)
}
/// Create a var that maps from this variable on read and to it on write.
///
/// The `map` closure is called once on initialization, and then once every time
/// the source variable updates, the `map_back` closure is called every time the output value is modified directly.
///
/// The mapping var can be [contextualized], see [`Var::map`] for more details.
///
/// If `self` can change the output variable will keep it alive, this is to support chaining maps.
///
/// [contextualized]: types::ContextualizedVar
fn map_bidi<O, M, B>(&self, map: M, map_back: B) -> Self::MapBidi<O>
where
O: VarValue,
M: FnMut(&T) -> O + Send + 'static,
B: FnMut(&O) -> T + Send + 'static;
/// Create a var that maps to an inner variable that is found inside the value of this variable.
///
/// The mapping var can be [contextualized] if self is contextual, otherwise `map` evaluates immediately to start. Note
/// that the "mapped-to" var can be contextual even when the mapping var is not.
///
/// The mapping var has the same capabilities of the inner var, plus `CAPS_CHANGE`, modifying the mapping var modifies the inner var.
///
/// If `self` can change the output variable will keep it alive, this is to support chaining maps.
///
/// [contextualized]: types::ContextualizedVar
fn flat_map<O, V, M>(&self, map: M) -> Self::FlatMap<O, V>
where
O: VarValue,
V: Var<O>,
M: FnMut(&T) -> V + Send + 'static;
/// Creates a ref-counted var that maps from this variable, but can retain a previous mapped value.
///
/// The `map` closure is called once on initialization, if it returns `None` the `fallback` closure is called to generate
/// a fallback value, after, the `map` closure is called once every time
/// the mapping variable reads and is out of sync with the source variable, if it returns `Some(_)` the mapping variable value changes,
/// otherwise the previous value is retained.
///
/// The mapping variable is read-only, use [`filter_map_bidi`] to map back.
///
/// The mapping var can be [contextualized], see [`Var::map`] for more details.
///
/// If `self` can change the output variable will keep it alive, this is to support chaining maps.
///
/// [contextualized]: types::ContextualizedVar
/// [`map_bidi`]: Var::map_bidi
/// [`filter_map_bidi`]: Var::filter_map_bidi
fn filter_map<O, M, I>(&self, map: M, fallback: I) -> Self::FilterMap<O>
where
O: VarValue,
M: FnMut(&T) -> Option<O> + Send + 'static,
I: Fn() -> O + Send + Sync + 'static;
/// Create a [`filter_map`] that tries to convert from `T` to `O` using [`TryInto<O>`].
///
/// [`filter_map`]: Var::filter_map
fn filter_try_into<O, I>(&self, fallback: I) -> Self::FilterMap<O>
where
O: VarValue,
T: TryInto<O>,
I: Fn() -> O + Send + Sync + 'static,
{
self.filter_map(|v| v.clone().try_into().ok(), fallback)
}
/// Create a [`filter_map`] that tries to convert from `T` to `O` using [`FromStr`].
///
/// [`filter_map`]: Var::filter_map
/// [`FromStr`]: std::str::FromStr
fn filter_parse<O, I>(&self, fallback: I) -> Self::FilterMap<O>
where
O: VarValue + std::str::FromStr,
T: AsRef<str>,
I: Fn() -> O + Send + Sync + 'static,
{
self.filter_map(|v| v.as_ref().parse().ok(), fallback)
}
/// Create a var that maps from this variable on read and to it on write, mapping in both directions can skip
/// updates, retaining the previous mapped value.
///
/// The `map` closure is called once on initialization, if it returns `None` the `fallback` closure is called
/// to generate a fallback value, after, the `map` closure is called once every time
/// the mapping variable reads and is out of sync with the source variable, if it returns `Some(_)` the mapping variable value changes,
/// otherwise the previous value is retained. The `map_back` closure
/// is called every time the output value is modified directly, if it returns `Some(_)` the source variable is set.
///
/// The mapping var can be [contextualized], see [`Var::map`] for more details.
///
/// If `self` can change the output variable will keep it alive, this is to support chaining maps.
///
/// [contextualized]: types::ContextualizedVar
fn filter_map_bidi<O, M, B, I>(&self, map: M, map_back: B, fallback: I) -> Self::FilterMapBidi<O>
where
O: VarValue,
M: FnMut(&T) -> Option<O> + Send + 'static,
B: FnMut(&O) -> Option<T> + Send + 'static,
I: Fn() -> O + Send + Sync + 'static;
/// Create a mapping wrapper around `self`. The `map` closure is called for each value access, it must reference the
/// value `O` that already exists in `T`.
fn map_ref<O, M>(&self, map: M) -> Self::MapRef<O>
where
O: VarValue,
M: Fn(&T) -> &O + Send + Sync + 'static;
/// Create a mapping wrapper around `self`. The `map` closure is called for each value access, it must reference the
/// value `O` that already exists in `T`, the `map_mut` closure is called for every modify request, it must do the same
/// as `map` but with mutable access.
fn map_ref_bidi<O, M, B>(&self, map: M, map_mut: B) -> Self::MapRefBidi<O>
where
O: VarValue,
M: Fn(&T) -> &O + Send + Sync + 'static,
B: Fn(&mut T) -> &mut O + Send + Sync + 'static;
/// Setup a hook that assigns `other` with the new values of `self` transformed by `map`.
///
/// Only a weak reference to the `other` variable is held, both variables update in the same app update cycle.
///
/// Note that the current value is not assigned, only the subsequent updates, you can use [`set_from_map`]
/// to sync the initial value.
///
/// [`set_from_map`]: Self::set_from_map
fn bind_map<T2, V2, M>(&self, other: &V2, map: M) -> VarHandle
where
T2: VarValue,
V2: Var<T2>,
M: FnMut(&T) -> T2 + Send + 'static,
{
var_bind_map(self, other, map)
}
/// Setup a hook that assigns `other` with the new values of `self` transformed by `map`, if the closure returns a value.
///
/// Only a weak reference to the `other` variable is held, both variables update in the same app update cycle.
///
/// Note that the current value is not assigned, only the subsequent updates, you can assign
/// `other` and then bind to fully sync the variables.
fn bind_filter_map<T2, V2, F>(&self, other: &V2, map: F) -> VarHandle
where
T2: VarValue,
V2: Var<T2>,
F: FnMut(&T) -> Option<T2> + Send + 'static,
{
var_bind_filter_map(self, other, map)
}
/// Bind `self` to `other` and back without causing an infinite loop.
///
/// Only a weak reference to each variable is held by the other, if both variables are scheduled to update in the same cycle
/// both get assigned, but only one bind transfer per app cycle is allowed for each variable. Returns two handles on the
/// the *map* hook and one for the *map-back* hook.
///
/// Note that the current value is not assigned, only the subsequent updates, you can assign
/// `other` and `self` and then bind to fully sync the variables.
fn bind_map_bidi<T2, V2, M, B>(&self, other: &V2, map: M, map_back: B) -> VarHandles
where
T2: VarValue,
V2: Var<T2>,
M: FnMut(&T) -> T2 + Send + 'static,
B: FnMut(&T2) -> T + Send + 'static,
{
var_bind_map_bidi(self, other, map, map_back)
}
/// Bind `self` to `other` and back with the new values of `self` transformed by `map` and the new values of `other` transformed
/// by `map_back`, the value is assigned in a update only if the closures returns a value.
///
/// Only a weak reference to each variable is held by the other, both variables update in the same app update cycle.
///
/// Note that the current value is not assigned, only the subsequent updates, you can assign
/// `other` and then bind to fully sync the variables.
fn bind_filter_map_bidi<T2, V2, M, B>(&self, other: &V2, map: M, map_back: B) -> VarHandles
where
T2: VarValue,
V2: Var<T2>,
M: FnMut(&T) -> Option<T2> + Send + 'static,
B: FnMut(&T2) -> Option<T> + Send + 'static,
{
var_bind_filter_map_bidi(self, other, map, map_back)
}
/// Setup a hook that assigns `other` with the new values of `self`.
///
/// Only a weak reference to the `other` variable is held.
///
/// Note that the current value is not assigned, only the subsequent updates, you can use
/// [`set_from`] to sync the initial value.
///
/// [`set_from`]: Self::set_from
fn bind<V2>(&self, other: &V2) -> VarHandle
where
V2: Var<T>,
{
self.bind_map(other, Clone::clone)
}
/// Calls `other.set_from(self)` and `self.bind(other)`.
fn set_bind<V2>(&self, other: &V2) -> VarHandle
where
V2: Var<T>,
{
let _ = other.set_from(self);
self.bind(other)
}
/// Setup two hooks that assigns `other` with the new values of `self` and `self` with the new values of `other`.
///
/// Only a weak reference to each variable is held by the other.
///
/// Note that the current value is not assigned, only the subsequent updates, you can assign
/// `other` using [`set_from`] and then bind to fully sync the variables.
///
/// [`set_from`]: Var::set_from
fn bind_bidi<V2>(&self, other: &V2) -> VarHandles
where
V2: Var<T>,
{
self.bind_map_bidi(other, Clone::clone, Clone::clone)
}
/// Debug helper for tracing the lifetime of a value in this variable.
///
/// The `enter_value` closure is called every time the variable updates, it can return
/// an implementation agnostic *scope* or *span* `S` that is only dropped when the variable updates again.
///
/// The `enter_value` is also called immediately when this method is called to start tracking the first value.
///
/// Returns a [`VarHandle`] that can be used to stop tracing.
///
/// If this variable can never update the span is immediately dropped and a dummy handle is returned. Note that
/// the trace is set on the [`actual_var`].
///
/// [`tracing`]: https://docs.rs/tracing
/// [`actual_var`]: Var::actual_var
fn trace_value<E, S>(&self, mut enter_value: E) -> VarHandle
where
E: FnMut(&TraceValueArgs<T>) -> S + Send + 'static,
S: Send + 'static,
{
let span = self.with(|v| {
enter_value(&TraceValueArgs {
args: &AnyVarHookArgs::new(v, false, &[]),
_type: PhantomData,
})
});
let data = Mutex::new((Some(span), enter_value));
self.hook_any(Box::new(move |args| {
let mut data = data.lock();
let (span, enter_value) = &mut *data;
let _ = span.take();
*span = Some(enter_value(&TraceValueArgs { args, _type: PhantomData }));
true
}))
}
/// Schedule an animation that targets this variable.
///
/// If the variable is always read-only no animation is created and a dummy handle returned. The animation
/// targets the current [`actual_var`] and is stopped if the variable is dropped.
///
/// The `animate` closure is called every frame, starting after next frame, the closure inputs are
/// the [`Animation`] args and *modify* access to the variable value, the args
/// can be used to calculate the new variable value and to control or stop the animation.
///
/// [`actual_var`]: Var::actual_var
/// [`Animation`]: animation::Animation
fn animate<A>(&self, animate: A) -> animation::AnimationHandle
where
A: FnMut(&animation::Animation, &mut VarModify<T>) + Send + 'static,
{
animation::var_animate(self, animate)
}
/// Schedule animations started by `animate`, the closure is called once at the start to begin, then again every time
/// the variable stops animating.
///
/// This can be used to create a sequence of animations or to repeat an animation. The sequence stops when `animate` returns
/// a dummy handle or the variable is modified outside of `animate`, or animations are disabled, or the returned handle is dropped.
fn sequence<A>(&self, animate: A) -> VarHandle
where
A: FnMut(&<<Self::ActualVar as Var<T>>::Downgrade as WeakVar<T>>::Upgrade) -> animation::AnimationHandle + Send + 'static,
{
animation::var_sequence(self, animate)
}
/// Schedule an easing transition from the `start_value` to `end_value`.
///
/// The variable updates every time the [`EasingStep`] for each frame changes and a different value is sampled.
///
/// See [`Var::animate`] for details about animations.
fn set_ease<S, E, F>(&self, start_value: S, end_value: E, duration: Duration, easing: F) -> animation::AnimationHandle
where
T: Transitionable,
S: Into<T>,
E: Into<T>,
F: Fn(EasingTime) -> EasingStep + Send + 'static,
{
self.set_ease_with(start_value, end_value, duration, easing, animation::Transition::sample)
}
/// Oscillate between `start_value` to `end_value` with an easing transition.
///
/// The `duration` defines the easing duration between the two values.
///
/// Note that you can use [`Var::sequence`] to create more complex looping animations.
fn set_ease_oci<S, E, F>(&self, start_value: S, end_value: E, duration: Duration, easing: F) -> animation::AnimationHandle
where
T: Transitionable,
S: Into<T>,
E: Into<T>,
F: Fn(EasingTime) -> EasingStep + Send + 'static,
{
self.set_ease_oci_with(start_value, end_value, duration, easing, animation::Transition::sample)
}
/// Schedule an easing transition from the `start_value` to `end_value` using a custom value sampler.
///
/// The variable updates every time the [`EasingStep`] for each frame changes and a different value is sampled.
///
/// See [`Var::animate`] for details about animations.
fn set_ease_with<S, E, F, Sa>(
&self,
start_value: S,
end_value: E,
duration: Duration,
easing: F,
sampler: Sa,
) -> animation::AnimationHandle
where
T: Transitionable,
S: Into<T>,
E: Into<T>,
F: Fn(EasingTime) -> EasingStep + Send + 'static,
Sa: Fn(&animation::Transition<T>, EasingStep) -> T + Send + 'static,
{
self.animate(animation::var_set_ease_with(
start_value.into(),
end_value.into(),
duration,
easing,
999.fct(),
sampler,
))
}
/// Oscillate between `start_value` to `end_value` with an easing transition using a custom value sampler.
///
/// The `duration` defines the easing duration between the two values.
///
/// Note that you can use [`Var::sequence`] to create more complex looping animations.
fn set_ease_oci_with<S, E, F, Sa>(
&self,
start_value: S,
end_value: E,
duration: Duration,
easing: F,
sampler: Sa,
) -> animation::AnimationHandle
where
T: Transitionable,
S: Into<T>,
E: Into<T>,
F: Fn(EasingTime) -> EasingStep + Send + 'static,
Sa: Fn(&animation::Transition<T>, EasingStep) -> T + Send + 'static,
{
self.animate(animation::var_set_ease_oci_with(
start_value.into(),
end_value.into(),
duration,
easing,
999.fct(),
sampler,
))
}
/// Schedule an easing transition from the current value to `new_value`.
///
/// The variable updates every time the [`EasingStep`] for each frame changes and a different value is sampled.
///
/// See [`Var::animate`] for details about animations.
fn ease<E, F>(&self, new_value: E, duration: Duration, easing: F) -> animation::AnimationHandle
where
T: Transitionable,
E: Into<T>,
F: Fn(EasingTime) -> EasingStep + Send + 'static,
{
self.ease_with(new_value, duration, easing, animation::Transition::sample)
}
/// Oscillate between the current value and `new_value` with an easing transition.
///
/// The `duration` defines the easing duration between the two values.
///
/// Note that you can use [`Var::sequence`] to create more complex looping animations.
fn ease_oci<E, F>(&self, new_value: E, duration: Duration, easing: F) -> animation::AnimationHandle
where
T: Transitionable,
E: Into<T>,
F: Fn(EasingTime) -> EasingStep + Send + 'static,
{
self.ease_oci_with(new_value, duration, easing, animation::Transition::sample)
}
/// Schedule an easing transition from the current value to `new_value` using a custom value sampler.
///
/// The variable updates every time the [`EasingStep`] for each frame changes and a different value is sampled.
///
/// See [`Var::animate`] for details about animations.
fn ease_with<E, F, S>(&self, new_value: E, duration: Duration, easing: F, sampler: S) -> animation::AnimationHandle
where
T: Transitionable,
E: Into<T>,
F: Fn(EasingTime) -> EasingStep + Send + 'static,
S: Fn(&animation::Transition<T>, EasingStep) -> T + Send + 'static,
{
self.animate(animation::var_set_ease_with(
self.get(),
new_value.into(),
duration,
easing,
0.fct(),
sampler,
))
}
/// Oscillate between the current value and `new_value` with an easing transition and a custom value sampler.
///
/// The `duration` defines the easing duration between the two values.
///
/// Note that you can use [`Var::sequence`] to create more complex looping animations.
fn ease_oci_with<E, F, S>(&self, new_value: E, duration: Duration, easing: F, sampler: S) -> animation::AnimationHandle
where
T: Transitionable,
E: Into<T>,
F: Fn(EasingTime) -> EasingStep + Send + 'static,
S: Fn(&animation::Transition<T>, EasingStep) -> T + Send + 'static,
{
self.animate(animation::var_set_ease_oci_with(
self.get(),
new_value.into(),
duration,
easing,
0.fct(),
sampler,
))
}
/// Schedule a keyframed transition animation for the variable, starting from the first key.
///
/// The variable will be set to the first keyframe, then animated across all other keys.
///
/// See [`Var::animate`] for details about animations.
fn set_ease_keyed<F>(&self, keys: Vec<(Factor, T)>, duration: Duration, easing: F) -> animation::AnimationHandle
where
T: Transitionable,
F: Fn(EasingTime) -> EasingStep + Send + 'static,
{
self.set_ease_keyed_with(keys, duration, easing, animation::TransitionKeyed::sample)
}
/// Schedule a keyframed transition animation for the variable, starting from the first key, using a custom value sampler.
///
/// The variable will be set to the first keyframe, then animated across all other keys.
///
/// See [`Var::animate`] for details about animations.
fn set_ease_keyed_with<F, S>(&self, keys: Vec<(Factor, T)>, duration: Duration, easing: F, sampler: S) -> animation::AnimationHandle
where
T: Transitionable,
F: Fn(EasingTime) -> EasingStep + Send + 'static,
S: Fn(&animation::TransitionKeyed<T>, EasingStep) -> T + Send + 'static,
{
if let Some(transition) = animation::TransitionKeyed::new(keys) {
self.animate(animation::var_set_ease_keyed_with(transition, duration, easing, 999.fct(), sampler))
} else {
animation::AnimationHandle::dummy()
}
}
/// Schedule a keyframed transition animation for the variable, starting from the current value.
///
/// The variable will be set to the first keyframe, then animated across all other keys.
///
/// See [`Var::animate`] for details about animations.
fn ease_keyed<F>(&self, keys: Vec<(Factor, T)>, duration: Duration, easing: F) -> animation::AnimationHandle
where
T: Transitionable,
F: Fn(EasingTime) -> EasingStep + Send + 'static,
{
self.ease_keyed_with(keys, duration, easing, animation::TransitionKeyed::sample)
}
/// Schedule a keyframed transition animation for the variable, starting from the current value, using a custom value sampler.
///
/// The variable will be set to the first keyframe, then animated across all other keys.
///
/// See [`Var::animate`] for details about animations.
fn ease_keyed_with<F, S>(&self, mut keys: Vec<(Factor, T)>, duration: Duration, easing: F, sampler: S) -> animation::AnimationHandle
where
T: Transitionable,
F: Fn(EasingTime) -> EasingStep + Send + 'static,
S: Fn(&animation::TransitionKeyed<T>, EasingStep) -> T + Send + 'static,
{
keys.insert(0, (0.fct(), self.get()));
let transition = animation::TransitionKeyed::new(keys).unwrap();
self.animate(animation::var_set_ease_keyed_with(transition, duration, easing, 0.fct(), sampler))
}
/// Set the variable to `new_value` after a `delay`.
///
/// The variable [`is_animating`] until the delay elapses and the value is set.
///
/// See [`Var::animate`] for details about animations.
///
/// [`is_animating`]: AnyVar::is_animating
fn step<N>(&self, new_value: N, delay: Duration) -> animation::AnimationHandle
where
N: Into<T>,
{
self.animate(animation::var_step(new_value.into(), delay))
}
/// Oscillate between the current value and `new_value`, every time the `delay` elapses the variable is set to the next value.
fn step_oci<N>(&self, new_value: N, delay: Duration) -> animation::AnimationHandle
where
N: Into<T>,
{
self.animate(animation::var_step_oci([self.get(), new_value.into()], delay, false))
}
/// Oscillate between `from` and `to`, the variable is set to `from` to start and every time the `delay` elapses
/// the variable is set to the next value.
fn set_step_oci<V0, V1>(&self, from: V0, to: V1, delay: Duration) -> animation::AnimationHandle
where
V0: Into<T>,
V1: Into<T>,
{
self.animate(animation::var_step_oci([from.into(), to.into()], delay, true))
}
/// Set the variable to a sequence of values as a time `duration` elapses.
///
/// An animation curve is used to find the first factor in `steps` above or at the curve line at the current time,
/// the variable is set to this step value, continuing animating across the next steps until the last or the animation end.
/// The variable [`is_animating`] from the start, even if no step applies and stays *animating* until the last *step* applies
/// or the duration is reached.
///
/// # Examples
///
/// Creates a variable that outputs text every 5% of a 5 seconds animation, advanced linearly.
///
/// ```
/// # use zng_var::{*, animation::easing};
/// # use zng_txt::*;
/// # use zng_unit::*;
/// # fn demo(text_var: impl Var<Txt>) {
/// let steps = (0..=100).step_by(5).map(|i| (i.pct().fct(), formatx!("{i}%"))).collect();
/// # let _ =
/// text_var.steps(steps, 5.secs(), easing::linear)
/// # ;}
/// ```
///
/// The variable is set to `"0%"`, after 5% of the `duration` elapses it is set to `"5%"` and so on
/// until the value is set to `"100%` at the end of the animation.
///
/// Returns an [`AnimationHandle`]. See [`Var::animate`] for details about animations.
///
/// [`is_animating`]: AnyVar::is_animating
/// [`AnimationHandle`]: animation::AnimationHandle
fn steps<F>(&self, steps: Vec<(Factor, T)>, duration: Duration, easing: F) -> animation::AnimationHandle
where
F: Fn(EasingTime) -> EasingStep + Send + 'static,
{
self.animate(animation::var_steps(steps, duration, easing))
}
/// Starts an easing animation that *chases* a target value that can be changed using the [`ChaseAnimation<T>`] handle.
///
/// [`ChaseAnimation<T>`]: animation::ChaseAnimation
fn chase<N, F>(&self, first_target: N, duration: Duration, easing: F) -> animation::ChaseAnimation<T>
where
N: Into<T>,
F: Fn(EasingTime) -> EasingStep + Send + 'static,
T: Transitionable,
{
animation::var_chase(self.clone().boxed(), first_target.into(), duration, easing)
}
/// Create a vars that [`ease`] to each new value of `self`.
///
/// Note that the mapping var can be [contextualized], see [`map`] for more details.
///
/// If `self` can change the output variable will keep it alive.
///
/// [contextualized]: types::ContextualizedVar
/// [`ease`]: Var::ease
/// [`map`]: Var::map
fn easing<F>(&self, duration: Duration, easing: F) -> Self::Easing
where
T: Transitionable,
F: Fn(EasingTime) -> EasingStep + Send + Sync + 'static;
/// Create a vars that [`ease_with`] to each new value of `self`.
///
/// Note that the mapping var can be [contextualized], see [`map`] for more details.
/// If `self` can change the output variable will keep it alive.
///
/// [contextualized]: types::ContextualizedVar
/// [`ease_with`]: Var::ease_with
/// [`map`]: Var::map
fn easing_with<F, S>(&self, duration: Duration, easing: F, sampler: S) -> Self::Easing
where
T: Transitionable,
F: Fn(EasingTime) -> EasingStep + Send + Sync + 'static,
S: Fn(&animation::Transition<T>, EasingStep) -> T + Send + Sync + 'static;
/// Returns a wrapper that implements [`fmt::Debug`] to write the var value.
fn debug(&self) -> types::VarDebug<T, Self> {
types::VarDebug {
var: self,
_t: PhantomData,
}
}
/// Returns a wrapper that implements [`fmt::Display`] to write the var value.
fn display(&self) -> types::VarDisplay<T, Self>
where
T: fmt::Display,
{
types::VarDisplay {
var: self,
_t: PhantomData,
}
}
/// Keep `value` alive until the handle or `self` are dropped.
fn hold<V>(&self, value: V) -> VarHandle
where
V: Any + Send,
{
let value = Mutex::new(value); // + Sync
self.hook_any(Box::new(move |_| {
let _hold = &value;
true
}))
}
}
fn var_bind_map<T, T2, V2, M>(source: &impl Var<T>, other: &V2, map: M) -> VarHandle
where
T: VarValue,
T2: VarValue,
V2: Var<T2>,
M: FnMut(&T) -> T2 + Send + 'static,
{
#[cfg(feature = "dyn_closure")]
let map: Box<dyn FnMut(&T) -> T2 + Send> = Box::new(map);
var_bind_map_impl(source, other, map)
}
fn var_bind_map_impl<T, T2, V2, M>(source: &impl Var<T>, other: &V2, mut map: M) -> VarHandle
where
T: VarValue,
T2: VarValue,
V2: Var<T2>,
M: FnMut(&T) -> T2 + Send + 'static,
{
var_bind(source, other, move |value, args, other| {
let value = map(value);
let update = args.update;
let _ = other.modify(move |vm| {
vm.set(value);
if update {
vm.update();
}
});
})
}
fn var_bind_filter_map<T, T2, V2, F>(source: &impl Var<T>, other: &V2, map: F) -> VarHandle
where
T: VarValue,
T2: VarValue,
V2: Var<T2>,
F: FnMut(&T) -> Option<T2> + Send + 'static,
{
#[cfg(feature = "dyn_closure")]
let map: Box<dyn FnMut(&T) -> Option<T2> + Send> = Box::new(map);
var_bind_filter_map_impl(source, other, map)
}
fn var_bind_filter_map_impl<T, T2, V2, F>(source: &impl Var<T>, other: &V2, mut map: F) -> VarHandle
where
T: VarValue,
T2: VarValue,
V2: Var<T2>,
F: FnMut(&T) -> Option<T2> + Send + 'static,
{
var_bind(source, other, move |value, args, other| {
if let Some(value) = map(value) {
let update = args.update;
let _ = other.modify(move |vm| {
vm.set(value);
if update {
vm.update();
}
});
}
})
}
fn var_bind_map_bidi<T, T2, V2, M, B>(source: &impl Var<T>, other: &V2, map: M, map_back: B) -> VarHandles
where
T: VarValue,
T2: VarValue,
V2: Var<T2>,
M: FnMut(&T) -> T2 + Send + 'static,
B: FnMut(&T2) -> T + Send + 'static,
{
#[cfg(feature = "dyn_closure")]
let map: Box<dyn FnMut(&T) -> T2 + Send + 'static> = Box::new(map);
#[cfg(feature = "dyn_closure")]
let map_back: Box<dyn FnMut(&T2) -> T + Send + 'static> = Box::new(map_back);
var_bind_map_bidi_impl(source, other, map, map_back)
}
fn var_bind_map_bidi_impl<T, T2, V2, M, B>(source: &impl Var<T>, other: &V2, mut map: M, mut map_back: B) -> VarHandles
where
T: VarValue,
T2: VarValue,
V2: Var<T2>,
M: FnMut(&T) -> T2 + Send + 'static,
B: FnMut(&T2) -> T + Send + 'static,
{
let source_tag = types::SourceVarTag::new(source);
let source_to_other = var_bind(source, other, move |value, args, other| {
let is_from_other = args
.downcast_tags::<types::SourceVarTag>()
.any(|&b| b == types::SourceVarTag::new(&other));
if !is_from_other {
let value = map(value);
let update = args.update;
let _ = other.modify(move |vm| {
vm.set(value);
vm.push_tag(source_tag);
if update {
vm.update();
}
});
}
});
let other_tag = types::SourceVarTag::new(other);
let other_to_source = var_bind(other, source, move |value, args, source| {
let is_from_source = args
.downcast_tags::<types::SourceVarTag>()
.any(|&b| b == types::SourceVarTag::new(&source));
if !is_from_source {
let value = map_back(value);
let update = args.update;
let _ = source.modify(move |vm| {
vm.set(value);
vm.push_tag(other_tag);
if update {
vm.update();
}
});
}
});
[source_to_other, other_to_source].into_iter().collect()
}
fn var_bind_filter_map_bidi<T, T2, V2, M, B>(source: &impl Var<T>, other: &V2, map: M, map_back: B) -> VarHandles
where
T: VarValue,
T2: VarValue,
V2: Var<T2>,
M: FnMut(&T) -> Option<T2> + Send + 'static,
B: FnMut(&T2) -> Option<T> + Send + 'static,
{
#[cfg(feature = "dyn_closure")]
let map: Box<dyn FnMut(&T) -> Option<T2> + Send + 'static> = Box::new(map);
#[cfg(feature = "dyn_closure")]
let map_back: Box<dyn FnMut(&T2) -> Option<T> + Send + 'static> = Box::new(map_back);
var_bind_filter_map_bidi_impl(source, other, map, map_back)
}
fn var_bind_filter_map_bidi_impl<T, T2, V2, M, B>(source: &impl Var<T>, other: &V2, mut map: M, mut map_back: B) -> VarHandles
where
T: VarValue,
T2: VarValue,
V2: Var<T2>,
M: FnMut(&T) -> Option<T2> + Send + 'static,
B: FnMut(&T2) -> Option<T> + Send + 'static,
{
let source_tag = types::SourceVarTag::new(source);
let source_to_other = var_bind(source, other, move |value, args, other| {
let is_from_other = args
.downcast_tags::<types::SourceVarTag>()
.any(|&b| b == types::SourceVarTag::new(&other));
if !is_from_other {
if let Some(value) = map(value) {
let update = args.update;
let _ = other.modify(move |vm| {
vm.set(value);
vm.push_tag(source_tag);
if update {
vm.update();
}
});
}
}
});
let other_tag = types::SourceVarTag::new(other);
let other_to_source = var_bind(other, source, move |value, args, source| {
let is_from_source = args
.downcast_tags::<types::SourceVarTag>()
.any(|&b| b == types::SourceVarTag::new(&source));
if !is_from_source {
if let Some(value) = map_back(value) {
let update = args.update;
let _ = source.modify(move |vm| {
vm.set(value);
vm.push_tag(other_tag);
if update {
vm.update();
}
});
}
}
});
[source_to_other, other_to_source].into_iter().collect()
}
fn var_hold_hook(source: &dyn AnyVar) -> Box<dyn Fn(&AnyVarHookArgs) -> bool + Send + Sync> {
let source = source.clone_any();
Box::new(move |_| {
let _hold = &source;
true
})
}
fn var_map<T: VarValue, O: VarValue>(source: &impl Var<T>, map: impl FnMut(&T) -> O + Send + 'static) -> ReadOnlyArcVar<O> {
#[cfg(feature = "dyn_closure")]
let map: Box<dyn FnMut(&T) -> O + Send> = Box::new(map);
var_map_impl(source, map)
}
fn var_map_impl<T: VarValue, O: VarValue>(source: &impl Var<T>, mut map: impl FnMut(&T) -> O + Send + 'static) -> ReadOnlyArcVar<O> {
let mapped = var(source.with(&mut map));
var_bind_map_impl(source, &mapped, map).perm();
mapped.hook_any(var_hold_hook(source)).perm();
mapped.read_only()
}
fn var_map_ctx<T: VarValue, O: VarValue>(
source: &impl Var<T>,
map: impl FnMut(&T) -> O + Send + 'static,
) -> contextualized::ContextualizedVar<O> {
#[cfg(feature = "dyn_closure")]
let map: Box<dyn FnMut(&T) -> O + Send> = Box::new(map);
var_map_ctx_impl(source, map)
}
fn var_map_ctx_impl<T: VarValue, O: VarValue>(
source: &impl Var<T>,
map: impl FnMut(&T) -> O + Send + 'static,
) -> contextualized::ContextualizedVar<O> {
let source = source.clone();
let map = Arc::new(Mutex::new(map));
types::ContextualizedVar::new(move || {
let other = var(source.with(&mut *map.lock()));
let map = map.clone();
source.bind_map(&other, move |t| map.lock()(t)).perm();
other.read_only()
})
}
fn var_map_mixed<T: VarValue, O: VarValue>(source: &impl Var<T>, map: impl FnMut(&T) -> O + Send + 'static) -> BoxedVar<O> {
#[cfg(feature = "dyn_closure")]
let map: Box<dyn FnMut(&T) -> O + Send> = Box::new(map);
if source.is_contextual() {
var_map_ctx_impl(source, map).boxed()
} else if source.capabilities().is_always_static() {
LocalVar(source.with(map)).boxed()
} else {
var_map_impl(source, map).boxed()
}
}
fn var_map_bidi<T, O, M, B>(source: &impl Var<T>, map: M, map_back: B) -> ArcVar<O>
where
T: VarValue,
O: VarValue,
M: FnMut(&T) -> O + Send + 'static,
B: FnMut(&O) -> T + Send + 'static,
{
#[cfg(feature = "dyn_closure")]
let map: Box<dyn FnMut(&T) -> O + Send> = Box::new(map);
#[cfg(feature = "dyn_closure")]
let map_back: Box<dyn FnMut(&O) -> T + Send> = Box::new(map_back);
var_map_bidi_impl(source, map, map_back)
}
fn var_map_bidi_impl<T, O, M, B>(source: &impl Var<T>, mut map: M, map_back: B) -> ArcVar<O>
where
T: VarValue,
O: VarValue,
M: FnMut(&T) -> O + Send + 'static,
B: FnMut(&O) -> T + Send + 'static,
{
let mapped = var(source.with(&mut map));
var_bind_map_bidi_impl(source, &mapped, map, map_back).perm();
mapped.hook_any(var_hold_hook(source)).perm();
mapped
}
fn var_map_bidi_ctx<T, O, M, B>(source: &impl Var<T>, map: M, map_back: B) -> types::ContextualizedVar<O>
where
T: VarValue,
O: VarValue,
M: FnMut(&T) -> O + Send + 'static,
B: FnMut(&O) -> T + Send + 'static,
{
#[cfg(feature = "dyn_closure")]
let map: Box<dyn FnMut(&T) -> O + Send> = Box::new(map);
#[cfg(feature = "dyn_closure")]
let map_back: Box<dyn FnMut(&O) -> T + Send> = Box::new(map_back);
var_map_bidi_ctx_impl(source, map, map_back)
}
fn var_map_bidi_ctx_impl<T, O, M, B>(source: &impl Var<T>, map: M, map_back: B) -> types::ContextualizedVar<O>
where
T: VarValue,
O: VarValue,
M: FnMut(&T) -> O + Send + 'static,
B: FnMut(&O) -> T + Send + 'static,
{
let me = source.clone();
let map = Arc::new(Mutex::new(map));
let map_back = Arc::new(Mutex::new(map_back));
types::ContextualizedVar::new(move || {
let other = var(me.with(&mut *map.lock()));
let map = map.clone();
let map_back = map_back.clone();
me.bind_map_bidi(&other, move |i| map.lock()(i), move |o| map_back.lock()(o)).perm();
other
})
}
fn var_map_bidi_mixed<T, O, M, B>(source: &impl Var<T>, map: M, map_back: B) -> BoxedVar<O>
where
T: VarValue,
O: VarValue,
M: FnMut(&T) -> O + Send + 'static,
B: FnMut(&O) -> T + Send + 'static,
{
#[cfg(feature = "dyn_closure")]
let map: Box<dyn FnMut(&T) -> O + Send> = Box::new(map);
#[cfg(feature = "dyn_closure")]
let map_back: Box<dyn FnMut(&O) -> T + Send> = Box::new(map_back);
if source.is_contextual() {
var_map_bidi_ctx_impl(source, map, map_back).boxed()
} else if source.capabilities().is_always_static() {
LocalVar(source.with(map)).boxed()
} else {
var_map_bidi_impl(source, map, map_back).boxed()
}
}
fn var_flat_map<T, O, V, M>(source: &impl Var<T>, map: M) -> types::ArcFlatMapVar<O, V>
where
T: VarValue,
O: VarValue,
V: Var<O>,
M: FnMut(&T) -> V + Send + 'static,
{
#[cfg(feature = "dyn_closure")]
let map: Box<dyn FnMut(&T) -> V + Send + 'static> = Box::new(map);
var_flat_map_impl(source, map)
}
fn var_flat_map_impl<T, O, V, M>(source: &impl Var<T>, map: M) -> types::ArcFlatMapVar<O, V>
where
T: VarValue,
O: VarValue,
V: Var<O>,
M: FnMut(&T) -> V + Send + 'static,
{
types::ArcFlatMapVar::new(source, map)
}
fn var_flat_map_ctx<T, O, V, M>(source: &impl Var<T>, map: M) -> types::ContextualizedVar<O>
where
T: VarValue,
O: VarValue,
V: Var<O>,
M: FnMut(&T) -> V + Send + 'static,
{
#[cfg(feature = "dyn_closure")]
let map: Box<dyn FnMut(&T) -> V + Send + 'static> = Box::new(map);
var_flat_map_ctx_impl(source, map)
}
fn var_flat_map_ctx_impl<T, O, V, M>(source: &impl Var<T>, map: M) -> types::ContextualizedVar<O>
where
T: VarValue,
O: VarValue,
V: Var<O>,
M: FnMut(&T) -> V + Send + 'static,
{
let me = source.clone();
let map = Arc::new(Mutex::new(map));
types::ContextualizedVar::new(move || {
let map = map.clone();
types::ArcFlatMapVar::new(&me, move |i| map.lock()(i))
})
}
fn var_flat_map_mixed<T, O, V, M>(source: &impl Var<T>, map: M) -> BoxedVar<O>
where
T: VarValue,
O: VarValue,
V: Var<O>,
M: FnMut(&T) -> V + Send + 'static,
{
#[cfg(feature = "dyn_closure")]
let map: Box<dyn FnMut(&T) -> V + Send + 'static> = Box::new(map);
if source.is_contextual() {
var_flat_map_ctx_impl(source, map).boxed()
} else if source.capabilities().is_always_static() {
source.with(map).boxed()
} else {
var_flat_map_impl(source, map).boxed()
}
}
fn var_filter_map<T, O, M, I>(source: &impl Var<T>, map: M, fallback: I) -> ReadOnlyArcVar<O>
where
T: VarValue,
O: VarValue,
M: FnMut(&T) -> Option<O> + Send + 'static,
I: Fn() -> O + Send + Sync + 'static,
{
#[cfg(feature = "dyn_closure")]
let map: Box<dyn FnMut(&T) -> Option<O> + Send + 'static> = Box::new(map);
#[cfg(feature = "dyn_closure")]
let fallback: Box<dyn Fn() -> O + Send + Sync + 'static> = Box::new(fallback);
var_filter_map_impl(source, map, fallback)
}
fn var_filter_map_impl<T, O, M, I>(source: &impl Var<T>, mut map: M, fallback: I) -> ReadOnlyArcVar<O>
where
T: VarValue,
O: VarValue,
M: FnMut(&T) -> Option<O> + Send + 'static,
I: Fn() -> O + Send + Sync + 'static,
{
let mapped = var(source.with(&mut map).unwrap_or_else(&fallback));
source.bind_filter_map(&mapped, map).perm();
mapped.hook_any(var_hold_hook(source)).perm();
mapped.read_only()
}
fn var_filter_map_ctx<T, O, M, I>(source: &impl Var<T>, map: M, fallback: I) -> types::ContextualizedVar<O>
where
T: VarValue,
O: VarValue,
M: FnMut(&T) -> Option<O> + Send + 'static,
I: Fn() -> O + Send + Sync + 'static,
{
#[cfg(feature = "dyn_closure")]
let map: Box<dyn FnMut(&T) -> Option<O> + Send + 'static> = Box::new(map);
#[cfg(feature = "dyn_closure")]
let fallback: Box<dyn Fn() -> O + Send + Sync + 'static> = Box::new(fallback);
var_filter_map_ctx_impl(source, map, fallback)
}
fn var_filter_map_ctx_impl<T, O, M, I>(source: &impl Var<T>, map: M, fallback: I) -> types::ContextualizedVar<O>
where
T: VarValue,
O: VarValue,
M: FnMut(&T) -> Option<O> + Send + 'static,
I: Fn() -> O + Send + Sync + 'static,
{
let me = source.clone();
let map = Arc::new(Mutex::new(map));
types::ContextualizedVar::new(move || {
let other = var(me.with(&mut *map.lock()).unwrap_or_else(&fallback));
let map = map.clone();
me.bind_filter_map(&other, move |i| map.lock()(i)).perm();
other.read_only()
})
}
fn var_filter_map_mixed<T, O, M, I>(source: &impl Var<T>, map: M, fallback: I) -> BoxedVar<O>
where
T: VarValue,
O: VarValue,
M: FnMut(&T) -> Option<O> + Send + 'static,
I: Fn() -> O + Send + Sync + 'static,
{
#[cfg(feature = "dyn_closure")]
let map: Box<dyn FnMut(&T) -> Option<O> + Send + 'static> = Box::new(map);
#[cfg(feature = "dyn_closure")]
let fallback: Box<dyn Fn() -> O + Send + Sync + 'static> = Box::new(fallback);
if source.is_contextual() {
var_filter_map_ctx_impl(source, map, fallback).boxed()
} else if source.capabilities().is_always_static() {
LocalVar(source.with(map).unwrap_or_else(fallback)).boxed()
} else {
var_filter_map_impl(source, map, fallback).boxed()
}
}
fn var_filter_map_bidi<T, O, M, B, I>(source: &impl Var<T>, map: M, map_back: B, fallback: I) -> ArcVar<O>
where
T: VarValue,
O: VarValue,
M: FnMut(&T) -> Option<O> + Send + 'static,
B: FnMut(&O) -> Option<T> + Send + 'static,
I: Fn() -> O + Send + Sync + 'static,
{
#[cfg(feature = "dyn_closure")]
let map: Box<dyn FnMut(&T) -> Option<O> + Send + 'static> = Box::new(map);
#[cfg(feature = "dyn_closure")]
let map_back: Box<dyn FnMut(&O) -> Option<T> + Send + 'static> = Box::new(map_back);
#[cfg(feature = "dyn_closure")]
let fallback: Box<dyn Fn() -> O + Send + Sync + 'static> = Box::new(fallback);
var_filter_map_bidi_impl(source, map, map_back, fallback)
}
fn var_filter_map_bidi_impl<T, O, M, B, I>(source: &impl Var<T>, mut map: M, map_back: B, fallback: I) -> ArcVar<O>
where
T: VarValue,
O: VarValue,
M: FnMut(&T) -> Option<O> + Send + 'static,
B: FnMut(&O) -> Option<T> + Send + 'static,
I: Fn() -> O + Send + Sync + 'static,
{
let mapped = var(source.with(&mut map).unwrap_or_else(&fallback));
source.bind_filter_map_bidi(&mapped, map, map_back).perm();
mapped.hook_any(var_hold_hook(source)).perm();
mapped
}
fn var_filter_map_bidi_ctx<T, O, M, B, I>(source: &impl Var<T>, map: M, map_back: B, fallback: I) -> types::ContextualizedVar<O>
where
T: VarValue,
O: VarValue,
M: FnMut(&T) -> Option<O> + Send + 'static,
B: FnMut(&O) -> Option<T> + Send + 'static,
I: Fn() -> O + Send + Sync + 'static,
{
#[cfg(feature = "dyn_closure")]
let map: Box<dyn FnMut(&T) -> Option<O> + Send + 'static> = Box::new(map);
#[cfg(feature = "dyn_closure")]
let map_back: Box<dyn FnMut(&O) -> Option<T> + Send + 'static> = Box::new(map_back);
#[cfg(feature = "dyn_closure")]
let fallback: Box<dyn Fn() -> O + Send + Sync + 'static> = Box::new(fallback);
var_filter_map_bidi_ctx_impl(source, map, map_back, fallback)
}
fn var_filter_map_bidi_ctx_impl<T, O, M, B, I>(source: &impl Var<T>, map: M, map_back: B, fallback: I) -> types::ContextualizedVar<O>
where
T: VarValue,
O: VarValue,
M: FnMut(&T) -> Option<O> + Send + 'static,
B: FnMut(&O) -> Option<T> + Send + 'static,
I: Fn() -> O + Send + Sync + 'static,
{
let me = source.clone();
let map = Arc::new(Mutex::new(map));
let map_back = Arc::new(Mutex::new(map_back));
types::ContextualizedVar::new(move || {
let other = var(me.with(&mut *map.lock()).unwrap_or_else(&fallback));
let map = map.clone();
let map_back = map_back.clone();
me.bind_filter_map_bidi(&other, move |i| map.lock()(i), move |o| map_back.lock()(o))
.perm();
other
})
}
fn var_filter_map_bidi_mixed<T, O, M, B, I>(source: &impl Var<T>, map: M, map_back: B, fallback: I) -> BoxedVar<O>
where
T: VarValue,
O: VarValue,
M: FnMut(&T) -> Option<O> + Send + 'static,
B: FnMut(&O) -> Option<T> + Send + 'static,
I: Fn() -> O + Send + Sync + 'static,
{
#[cfg(feature = "dyn_closure")]
let map: Box<dyn FnMut(&T) -> Option<O> + Send + 'static> = Box::new(map);
#[cfg(feature = "dyn_closure")]
let map_back: Box<dyn FnMut(&O) -> Option<T> + Send + 'static> = Box::new(map_back);
#[cfg(feature = "dyn_closure")]
let fallback: Box<dyn Fn() -> O + Send + Sync + 'static> = Box::new(fallback);
if source.is_contextual() {
var_filter_map_bidi_ctx_impl(source, map, map_back, fallback).boxed()
} else if source.capabilities().is_always_static() {
LocalVar(source.with(map).unwrap_or_else(fallback)).boxed()
} else {
var_filter_map_bidi_impl(source, map, map_back, fallback).boxed()
}
}
fn var_map_ref<T, S, O, M>(source: &S, map: M) -> types::MapRef<T, O, S>
where
T: VarValue,
S: Var<T>,
O: VarValue,
M: Fn(&T) -> &O + Send + Sync + 'static,
{
types::MapRef::new(source.clone(), Arc::new(map))
}
fn var_map_ref_bidi<T, S, O, M, B>(source: &S, map: M, map_mut: B) -> types::MapRefBidi<T, O, S>
where
T: VarValue,
S: Var<T>,
O: VarValue,
M: Fn(&T) -> &O + Send + Sync + 'static,
B: Fn(&mut T) -> &mut O + Send + Sync + 'static,
{
types::MapRefBidi::new(source.clone(), Arc::new(map), Arc::new(map_mut))
}
fn var_easing<T, F>(source: &impl Var<T>, duration: Duration, easing: F) -> ReadOnlyArcVar<T>
where
T: VarValue + Transitionable,
F: Fn(EasingTime) -> EasingStep + Send + Sync + 'static,
{
let easing_fn = Arc::new(easing);
let easing_var = var(source.get());
let mut _anim_handle = animation::AnimationHandle::dummy();
var_bind(source, &easing_var, move |value, args, easing_var| {
_anim_handle = easing_var.ease(value.clone(), duration, clmv!(easing_fn, |t| easing_fn(t)));
if args.update {
easing_var.update();
}
})
.perm();
easing_var.hook_any(var_hold_hook(source)).perm();
easing_var.read_only()
}
fn var_easing_ctx<T, F>(source: &impl Var<T>, duration: Duration, easing: F) -> types::ContextualizedVar<T>
where
T: VarValue + Transitionable,
F: Fn(EasingTime) -> EasingStep + Send + Sync + 'static,
{
let source = source.clone();
let easing_fn = Arc::new(easing);
types::ContextualizedVar::new(move || {
let easing_var = var(source.get());
let easing_fn = easing_fn.clone();
let mut _anim_handle = animation::AnimationHandle::dummy();
var_bind(&source, &easing_var, move |value, args, easing_var| {
let easing_fn = easing_fn.clone();
_anim_handle = easing_var.ease(value.clone(), duration, move |t| easing_fn(t));
if args.update {
easing_var.update();
}
})
.perm();
easing_var.read_only()
})
}
fn var_easing_mixed<T, F>(source: &impl Var<T>, duration: Duration, easing: F) -> BoxedVar<T>
where
T: VarValue + Transitionable,
F: Fn(EasingTime) -> EasingStep + Send + Sync + 'static,
{
if source.is_contextual() {
var_easing_ctx(source, duration, easing).boxed()
} else if source.capabilities().is_always_static() {
source.clone().boxed()
} else {
var_easing(source, duration, easing).boxed()
}
}
fn var_easing_with<T, F, S>(source: &impl Var<T>, duration: Duration, easing: F, sampler: S) -> ReadOnlyArcVar<T>
where
T: VarValue + Transitionable,
F: Fn(EasingTime) -> EasingStep + Send + Sync + 'static,
S: Fn(&animation::Transition<T>, EasingStep) -> T + Send + Sync + 'static,
{
let fns = Arc::new((easing, sampler));
let easing_var = var(source.get());
let mut _anim_handle = animation::AnimationHandle::dummy();
var_bind(source, &easing_var, move |value, args, easing_var| {
_anim_handle = easing_var.ease_with(
value.clone(),
duration,
clmv!(fns, |t| (fns.0)(t)),
clmv!(fns, |t, s| (fns.1)(t, s)),
);
if args.update {
easing_var.update();
}
})
.perm();
easing_var.hook_any(var_hold_hook(source)).perm();
easing_var.read_only()
}
fn var_easing_with_ctx<T, F, S>(source: &impl Var<T>, duration: Duration, easing: F, sampler: S) -> types::ContextualizedVar<T>
where
T: VarValue + Transitionable,
F: Fn(EasingTime) -> EasingStep + Send + Sync + 'static,
S: Fn(&animation::Transition<T>, EasingStep) -> T + Send + Sync + 'static,
{
let source = source.clone();
let fns = Arc::new((easing, sampler));
types::ContextualizedVar::new(move || {
let easing_var = var(source.get());
let fns = fns.clone();
let mut _anim_handle = animation::AnimationHandle::dummy();
var_bind(&source, &easing_var, move |value, args, easing_var| {
_anim_handle = easing_var.ease_with(
value.clone(),
duration,
clmv!(fns, |t| (fns.0)(t)),
clmv!(fns, |t, s| (fns.1)(t, s)),
);
if args.update {
easing_var.update();
}
})
.perm();
easing_var.read_only()
})
}
fn var_easing_with_mixed<T, F, S>(source: &impl Var<T>, duration: Duration, easing: F, sampler: S) -> BoxedVar<T>
where
T: VarValue + Transitionable,
F: Fn(EasingTime) -> EasingStep + Send + Sync + 'static,
S: Fn(&animation::Transition<T>, EasingStep) -> T + Send + Sync + 'static,
{
if source.is_contextual() {
var_easing_with_ctx(source, duration, easing, sampler).boxed()
} else if source.capabilities().is_always_static() {
source.clone().boxed()
} else {
var_easing_with(source, duration, easing, sampler).boxed()
}
}
// Closure type independent of the variable type, hopefully reduces LLVM lines:
fn var_get_into<T>(value: &mut T) -> impl FnOnce(&T) + '_
where
T: VarValue,
{
move |var_value| value.clone_from(var_value)
}
fn var_get_ne<T>(value: &mut T) -> impl FnOnce(&T) -> bool + '_
where
T: VarValue + PartialEq,
{
move |var_value| {
let ne = var_value != value;
if ne {
value.clone_from(var_value);
}
ne
}
}
fn var_set<T>(value: T) -> impl FnOnce(&mut VarModify<T>)
where
T: VarValue,
{
move |var_value| {
var_value.set(value);
}
}
fn var_set_from<T, I>(other: I) -> impl FnOnce(&mut VarModify<T>)
where
T: VarValue,
I: Var<T>,
{
move |vm| {
let other_tag = types::SourceVarTag::new(&other);
let importance = other.modify_importance();
other.with(|other| {
if vm.as_ref() != other {
vm.set(other.clone());
vm.push_tag(other_tag);
}
vm.set_modify_importance(importance);
})
}
}
fn var_set_from_map<T, Iv, I, M>(other: I, map: M) -> impl FnOnce(&mut VarModify<T>)
where
Iv: VarValue,
I: Var<Iv>,
M: FnOnce(&Iv) -> T + Send + 'static,
T: VarValue,
{
move |vm| {
let value = other.with(map);
if vm.as_ref() != &value {
vm.set(value);
vm.push_tag(types::SourceVarTag::new(&other));
}
vm.set_modify_importance(other.modify_importance());
}
}
fn var_set_any<T>(value: Box<dyn AnyVarValue>) -> impl FnOnce(&mut VarModify<T>)
where
T: VarValue,
{
match value.into_any().downcast::<T>() {
Ok(value) => var_set(*value),
Err(_) => panic!("cannot `set_any`, incompatible type"),
}
}
fn var_update<T>(var_value: &mut VarModify<T>)
where
T: VarValue,
{
var_value.update();
}
fn var_debug<T>(value: &T) -> Txt
where
T: VarValue,
{
formatx!("{value:?}")
}
fn var_bind<I, O, V>(
input: &impl Var<I>,
output: &V,
update_output: impl FnMut(&I, &AnyVarHookArgs, <V::Downgrade as WeakVar<O>>::Upgrade) + Send + 'static,
) -> VarHandle
where
I: VarValue,
O: VarValue,
V: Var<O>,
{
if input.capabilities().is_always_static() || output.capabilities().is_always_read_only() {
VarHandle::dummy()
} else {
#[cfg(feature = "dyn_closure")]
let update_output: Box<dyn FnMut(&I, &AnyVarHookArgs, <V::Downgrade as WeakVar<O>>::Upgrade) + Send + 'static> =
Box::new(update_output);
var_bind_ok(input, output.downgrade(), update_output)
}
}
fn var_bind_ok<I, O, W>(
input: &impl Var<I>,
wk_output: W,
update_output: impl FnMut(&I, &AnyVarHookArgs, W::Upgrade) + Send + 'static,
) -> VarHandle
where
I: VarValue,
O: VarValue,
W: WeakVar<O>,
{
let update_output = Mutex::new(update_output);
input.hook_any(Box::new(move |args| {
if let Some(output) = wk_output.upgrade() {
if output.capabilities().contains(VarCapability::MODIFY) {
if let Some(value) = args.downcast_value::<I>() {
update_output.lock()(value, args, output);
}
}
true
} else {
false
}
}))
}
macro_rules! impl_infallible_write {
(for<$T:ident>) => {
/// Infallible [`Var::modify`].
pub fn modify(&self, modify: impl FnOnce(&mut $crate::VarModify<$T>) + Send + 'static) {
Var::modify(self, modify).unwrap()
}
/// Infallible [`Var::set`].
pub fn set(&self, value: impl Into<$T>) {
Var::set(self, value).unwrap()
}
/// Infallible [`AnyVar::update`].
pub fn update(&self) {
AnyVar::update(self).unwrap()
}
/// Infallible [`Var::set_from`].
pub fn set_from<I: Var<$T>>(&self, other: &I) {
Var::set_from(self, other).unwrap()
}
/// Infallible [`Var::set_from_map`].
pub fn set_from_map<Iv, I, M>(&self, other: &I, map: M)
where
Iv: VarValue,
I: Var<Iv>,
M: FnOnce(&Iv) -> $T + Send + 'static,
{
Var::set_from_map(self, other, map).unwrap()
}
};
}
use impl_infallible_write;