gio/auto/file.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 2874 2875 2876 2877 2878 2879 2880 2881 2882 2883 2884 2885 2886 2887 2888 2889 2890 2891 2892 2893 2894 2895 2896 2897 2898 2899 2900 2901 2902 2903 2904 2905 2906 2907 2908 2909 2910 2911 2912 2913 2914 2915 2916 2917 2918 2919 2920 2921 2922 2923 2924 2925 2926 2927 2928 2929 2930 2931 2932 2933 2934 2935 2936 2937 2938 2939 2940 2941 2942 2943 2944 2945 2946 2947 2948 2949 2950 2951 2952 2953 2954 2955 2956 2957 2958 2959 2960 2961 2962 2963 2964 2965 2966 2967 2968 2969 2970 2971 2972 2973 2974 2975 2976 2977 2978 2979 2980 2981 2982 2983 2984 2985 2986 2987 2988 2989 2990 2991 2992 2993 2994 2995 2996 2997 2998 2999 3000 3001 3002 3003 3004 3005 3006 3007 3008 3009 3010 3011 3012 3013 3014 3015 3016 3017 3018 3019 3020 3021 3022 3023 3024 3025 3026 3027 3028 3029 3030 3031 3032 3033 3034 3035 3036 3037 3038 3039 3040 3041 3042 3043 3044 3045 3046 3047 3048 3049 3050 3051 3052 3053 3054 3055 3056 3057 3058 3059 3060 3061 3062 3063 3064 3065 3066 3067 3068 3069 3070 3071 3072 3073 3074 3075 3076 3077 3078 3079 3080 3081 3082 3083 3084 3085 3086 3087 3088 3089 3090 3091 3092 3093 3094 3095 3096 3097 3098 3099 3100 3101 3102 3103 3104 3105 3106 3107 3108 3109 3110 3111 3112 3113 3114 3115 3116 3117 3118 3119 3120 3121 3122 3123 3124 3125 3126 3127 3128 3129 3130 3131 3132 3133 3134 3135 3136 3137 3138 3139 3140 3141 3142 3143 3144 3145 3146 3147 3148 3149 3150 3151 3152 3153 3154 3155 3156 3157 3158 3159 3160 3161 3162 3163 3164 3165 3166 3167 3168 3169 3170 3171 3172 3173 3174 3175 3176 3177 3178 3179 3180 3181 3182 3183 3184 3185 3186 3187 3188 3189 3190 3191 3192 3193 3194 3195 3196 3197 3198 3199 3200 3201 3202 3203 3204 3205 3206 3207 3208 3209 3210 3211 3212 3213 3214 3215 3216 3217 3218 3219 3220 3221 3222 3223 3224 3225 3226 3227 3228 3229 3230 3231 3232 3233 3234 3235 3236 3237 3238 3239 3240 3241 3242 3243 3244 3245 3246 3247 3248 3249 3250 3251 3252 3253 3254 3255 3256 3257 3258 3259 3260 3261 3262 3263 3264 3265 3266 3267 3268 3269 3270 3271 3272 3273 3274 3275 3276 3277 3278 3279 3280 3281 3282 3283 3284 3285 3286 3287 3288 3289 3290 3291 3292 3293 3294 3295 3296 3297 3298 3299 3300 3301 3302 3303 3304 3305 3306 3307 3308 3309 3310 3311 3312 3313 3314 3315 3316 3317 3318 3319 3320 3321 3322 3323 3324 3325 3326 3327 3328 3329 3330 3331 3332 3333 3334 3335 3336 3337 3338 3339 3340 3341 3342 3343 3344 3345 3346 3347 3348 3349 3350 3351 3352 3353 3354 3355 3356 3357 3358 3359 3360 3361 3362 3363 3364 3365 3366 3367 3368 3369 3370 3371 3372 3373 3374 3375 3376 3377 3378 3379 3380 3381 3382 3383 3384 3385 3386 3387 3388 3389 3390 3391 3392 3393 3394 3395 3396 3397 3398 3399 3400 3401 3402 3403 3404 3405 3406 3407 3408 3409 3410 3411 3412 3413 3414 3415 3416 3417 3418 3419 3420 3421 3422 3423 3424 3425 3426 3427 3428 3429 3430 3431 3432 3433 3434 3435 3436 3437 3438 3439 3440 3441 3442 3443 3444 3445 3446 3447 3448 3449 3450 3451 3452 3453 3454 3455 3456 3457 3458 3459 3460 3461 3462 3463 3464 3465 3466 3467 3468 3469 3470 3471 3472 3473 3474 3475 3476 3477 3478 3479 3480 3481 3482 3483 3484 3485 3486 3487 3488 3489 3490 3491 3492 3493 3494 3495 3496 3497 3498 3499 3500 3501 3502 3503 3504 3505 3506 3507 3508 3509 3510 3511 3512 3513 3514 3515 3516 3517 3518 3519 3520 3521 3522 3523 3524 3525 3526 3527 3528 3529 3530 3531 3532 3533 3534 3535 3536 3537 3538 3539 3540 3541 3542 3543 3544 3545 3546 3547 3548 3549 3550 3551 3552 3553 3554 3555 3556 3557 3558 3559 3560 3561 3562 3563 3564 3565 3566 3567 3568 3569 3570 3571 3572 3573 3574 3575 3576 3577 3578 3579 3580 3581 3582 3583 3584 3585 3586 3587 3588 3589 3590 3591 3592 3593 3594 3595 3596 3597 3598 3599 3600 3601 3602 3603 3604 3605 3606 3607 3608 3609 3610 3611 3612 3613 3614 3615 3616 3617 3618 3619 3620 3621 3622 3623 3624 3625 3626 3627 3628 3629 3630 3631 3632 3633 3634 3635 3636 3637 3638 3639 3640 3641 3642 3643 3644 3645 3646 3647 3648 3649 3650 3651 3652 3653 3654 3655 3656 3657 3658 3659 3660 3661 3662 3663 3664 3665 3666 3667 3668 3669 3670 3671 3672 3673 3674 3675 3676 3677 3678 3679 3680 3681 3682 3683 3684 3685 3686 3687 3688 3689 3690 3691 3692 3693 3694 3695 3696 3697 3698 3699 3700 3701 3702 3703 3704 3705 3706 3707 3708 3709 3710 3711 3712 3713 3714 3715 3716 3717 3718 3719 3720 3721 3722 3723 3724 3725 3726 3727 3728 3729 3730 3731 3732 3733 3734 3735 3736 3737 3738 3739 3740 3741 3742 3743 3744 3745 3746 3747 3748 3749 3750 3751 3752 3753 3754 3755 3756 3757 3758 3759 3760 3761 3762 3763 3764 3765 3766 3767 3768 3769 3770 3771 3772 3773 3774 3775 3776 3777 3778 3779 3780 3781 3782 3783 3784 3785 3786 3787 3788 3789 3790 3791 3792 3793 3794 3795 3796 3797 3798 3799 3800 3801 3802 3803 3804 3805 3806 3807 3808 3809 3810 3811 3812 3813 3814 3815 3816 3817 3818 3819 3820 3821 3822 3823 3824 3825 3826 3827 3828 3829 3830 3831 3832 3833 3834 3835 3836 3837 3838 3839 3840 3841 3842 3843 3844 3845 3846 3847 3848 3849 3850 3851 3852 3853 3854 3855 3856 3857 3858 3859 3860 3861 3862 3863 3864 3865 3866 3867 3868 3869 3870 3871 3872 3873 3874 3875 3876 3877 3878 3879 3880 3881 3882 3883 3884 3885 3886 3887 3888 3889 3890 3891 3892 3893 3894 3895 3896 3897 3898 3899 3900 3901 3902 3903 3904 3905 3906 3907 3908 3909 3910 3911 3912 3913 3914 3915 3916 3917 3918 3919 3920 3921 3922 3923 3924 3925 3926 3927 3928 3929 3930 3931 3932 3933 3934 3935 3936 3937 3938 3939 3940 3941 3942 3943 3944 3945 3946 3947 3948 3949 3950 3951 3952 3953 3954 3955 3956 3957 3958 3959 3960 3961 3962 3963 3964 3965 3966 3967 3968 3969 3970 3971 3972 3973 3974 3975 3976 3977 3978 3979 3980 3981 3982 3983 3984 3985 3986 3987 3988 3989 3990 3991 3992 3993 3994 3995 3996 3997 3998 3999 4000 4001 4002 4003 4004 4005 4006 4007 4008 4009 4010 4011 4012 4013 4014 4015 4016 4017 4018 4019 4020 4021 4022 4023 4024 4025 4026 4027 4028 4029 4030 4031 4032 4033 4034 4035 4036 4037 4038 4039 4040 4041 4042 4043 4044 4045 4046 4047 4048 4049 4050 4051 4052 4053 4054 4055 4056 4057 4058 4059 4060 4061 4062 4063 4064 4065 4066 4067 4068 4069 4070 4071 4072 4073 4074 4075 4076 4077 4078 4079 4080 4081 4082 4083 4084 4085 4086 4087 4088 4089 4090 4091 4092 4093 4094 4095 4096 4097 4098 4099 4100 4101 4102 4103 4104 4105 4106 4107 4108 4109 4110 4111 4112 4113 4114 4115 4116 4117 4118 4119 4120 4121 4122 4123 4124 4125 4126 4127 4128 4129 4130 4131 4132 4133 4134 4135 4136 4137 4138 4139 4140 4141 4142 4143 4144 4145 4146 4147 4148 4149 4150 4151 4152 4153 4154 4155 4156 4157 4158 4159 4160 4161 4162 4163 4164 4165 4166 4167 4168 4169 4170 4171 4172 4173 4174 4175 4176 4177 4178 4179 4180 4181 4182 4183 4184 4185 4186 4187 4188 4189 4190 4191 4192 4193 4194 4195 4196 4197 4198 4199 4200 4201 4202 4203 4204 4205 4206 4207 4208 4209 4210 4211 4212 4213 4214 4215 4216 4217 4218 4219 4220 4221 4222 4223 4224 4225 4226 4227 4228 4229 4230 4231 4232 4233 4234 4235 4236 4237 4238 4239 4240 4241 4242 4243 4244 4245 4246 4247 4248 4249 4250 4251 4252 4253 4254 4255 4256 4257 4258 4259 4260 4261 4262 4263 4264 4265 4266 4267 4268 4269 4270 4271 4272 4273 4274 4275 4276 4277 4278 4279 4280 4281 4282 4283 4284 4285 4286 4287 4288 4289 4290 4291 4292 4293 4294 4295 4296 4297 4298 4299 4300 4301 4302 4303 4304 4305 4306 4307 4308 4309 4310 4311 4312 4313 4314 4315 4316 4317 4318 4319 4320 4321 4322 4323 4324 4325 4326 4327 4328 4329 4330 4331 4332 4333 4334 4335 4336 4337 4338 4339 4340 4341 4342 4343 4344 4345 4346 4347 4348 4349 4350 4351 4352 4353 4354 4355 4356 4357 4358 4359 4360 4361 4362 4363 4364 4365 4366 4367 4368 4369 4370 4371 4372 4373 4374 4375 4376 4377 4378 4379 4380 4381 4382 4383 4384 4385 4386 4387 4388 4389 4390 4391 4392 4393 4394 4395 4396 4397 4398 4399 4400 4401 4402 4403 4404 4405 4406 4407 4408 4409 4410 4411 4412 4413 4414 4415 4416 4417 4418 4419 4420 4421 4422 4423 4424 4425 4426 4427 4428 4429 4430 4431 4432 4433 4434 4435 4436 4437 4438 4439 4440 4441 4442 4443 4444 4445 4446 4447 4448 4449 4450 4451 4452 4453 4454 4455 4456 4457 4458 4459 4460 4461 4462 4463 4464 4465 4466 4467 4468 4469 4470 4471 4472 4473 4474 4475 4476 4477 4478 4479 4480 4481 4482 4483 4484 4485 4486 4487 4488 4489 4490 4491 4492 4493 4494 4495 4496 4497 4498 4499 4500 4501 4502 4503 4504 4505 4506 4507 4508 4509 4510 4511 4512 4513 4514 4515 4516 4517 4518 4519 4520 4521 4522 4523 4524 4525 4526 4527 4528 4529 4530 4531 4532 4533 4534 4535 4536 4537 4538 4539 4540 4541 4542 4543 4544 4545 4546 4547 4548 4549 4550 4551 4552 4553 4554 4555 4556 4557 4558 4559 4560 4561 4562 4563 4564 4565 4566 4567 4568 4569 4570 4571 4572 4573 4574 4575 4576 4577 4578 4579 4580 4581 4582 4583 4584 4585 4586 4587 4588 4589 4590 4591
// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT
use crate::{
ffi, AppInfo, AsyncResult, Cancellable, DriveStartFlags, FileAttributeInfoList, FileCopyFlags,
FileCreateFlags, FileEnumerator, FileIOStream, FileInfo, FileInputStream, FileMonitor,
FileMonitorFlags, FileOutputStream, FileQueryInfoFlags, FileType, Mount, MountMountFlags,
MountOperation, MountUnmountFlags,
};
use glib::{prelude::*, translate::*};
use std::{boxed::Box as Box_, pin::Pin};
glib::wrapper! {
/// `GFile` is a high level abstraction for manipulating files on a
/// virtual file system. `GFile`s are lightweight, immutable objects
/// that do no I/O upon creation. It is necessary to understand that
/// `GFile` objects do not represent files, merely an identifier for a
/// file. All file content I/O is implemented as streaming operations
/// (see [`InputStream`][crate::InputStream] and [`OutputStream`][crate::OutputStream]).
///
/// To construct a `GFile`, you can use:
///
/// - [`for_path()`][Self::for_path()] if you have a path.
/// - [`for_uri()`][Self::for_uri()] if you have a URI.
/// - [`for_commandline_arg()`][Self::for_commandline_arg()] or
/// [`for_commandline_arg_and_cwd()`][Self::for_commandline_arg_and_cwd()] for a command line
/// argument.
/// - [`new_tmp()`][Self::new_tmp()] to create a temporary file from a template.
/// - [`new_tmp_async()`][Self::new_tmp_async()] to asynchronously create a temporary file.
/// - [`new_tmp_dir_async()`][Self::new_tmp_dir_async()] to asynchronously create a temporary
/// directory.
/// - [`for_parse_name()`][Self::for_parse_name()] from a UTF-8 string gotten from
/// [`FileExt::parse_name()`][crate::prelude::FileExt::parse_name()].
/// - `Gio::File::new_build_filename()` or [`new_build_filenamev()`][Self::new_build_filenamev()]
/// to create a file from path elements.
///
/// One way to think of a `GFile` is as an abstraction of a pathname. For
/// normal files the system pathname is what is stored internally, but as
/// `GFile`s are extensible it could also be something else that corresponds
/// to a pathname in a userspace implementation of a filesystem.
///
/// `GFile`s make up hierarchies of directories and files that correspond to
/// the files on a filesystem. You can move through the file system with
/// `GFile` using [`FileExt::parent()`][crate::prelude::FileExt::parent()] to get an identifier for the
/// parent directory, [`FileExt::child()`][crate::prelude::FileExt::child()] to get a child within a
/// directory, and [`FileExt::resolve_relative_path()`][crate::prelude::FileExt::resolve_relative_path()] to resolve a relative
/// path between two `GFile`s. There can be multiple hierarchies, so you may not
/// end up at the same root if you repeatedly call [`FileExt::parent()`][crate::prelude::FileExt::parent()]
/// on two different files.
///
/// All `GFile`s have a basename (get with [`FileExt::basename()`][crate::prelude::FileExt::basename()]). These
/// names are byte strings that are used to identify the file on the filesystem
/// (relative to its parent directory) and there is no guarantees that they
/// have any particular charset encoding or even make any sense at all. If
/// you want to use filenames in a user interface you should use the display
/// name that you can get by requesting the
/// `G_FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME` attribute with
/// [`FileExt::query_info()`][crate::prelude::FileExt::query_info()]. This is guaranteed to be in UTF-8 and can be
/// used in a user interface. But always store the real basename or the `GFile`
/// to use to actually access the file, because there is no way to go from a
/// display name to the actual name.
///
/// Using `GFile` as an identifier has the same weaknesses as using a path
/// in that there may be multiple aliases for the same file. For instance,
/// hard or soft links may cause two different `GFile`s to refer to the same
/// file. Other possible causes for aliases are: case insensitive filesystems,
/// short and long names on FAT/NTFS, or bind mounts in Linux. If you want to
/// check if two `GFile`s point to the same file you can query for the
/// `G_FILE_ATTRIBUTE_ID_FILE` attribute. Note that `GFile` does some trivial
/// canonicalization of pathnames passed in, so that trivial differences in
/// the path string used at creation (duplicated slashes, slash at end of
/// path, `.` or `..` path segments, etc) does not create different `GFile`s.
///
/// Many `GFile` operations have both synchronous and asynchronous versions
/// to suit your application. Asynchronous versions of synchronous functions
/// simply have `_async()` appended to their function names. The asynchronous
/// I/O functions call a `callback::Gio::AsyncReadyCallback which is then used to
/// finalize the operation, producing a [`AsyncResult`][crate::AsyncResult] which is then
/// passed to the function’s matching `_finish()` operation.
///
/// It is highly recommended to use asynchronous calls when running within a
/// shared main loop, such as in the main thread of an application. This avoids
/// I/O operations blocking other sources on the main loop from being dispatched.
/// Synchronous I/O operations should be performed from worker threads. See the
/// [introduction to asynchronous programming section](overview.html#asynchronous-programming)
/// for more.
///
/// Some `GFile` operations almost always take a noticeable amount of time, and
/// so do not have synchronous analogs. Notable cases include:
///
/// - [`FileExt::mount_mountable()`][crate::prelude::FileExt::mount_mountable()] to mount a mountable file.
/// - [`FileExt::unmount_mountable_with_operation()`][crate::prelude::FileExt::unmount_mountable_with_operation()] to unmount a mountable
/// file.
/// - [`FileExt::eject_mountable_with_operation()`][crate::prelude::FileExt::eject_mountable_with_operation()] to eject a mountable file.
///
/// ## Entity Tags
///
/// One notable feature of `GFile`s are entity tags, or ‘etags’ for
/// short. Entity tags are somewhat like a more abstract version of the
/// traditional mtime, and can be used to quickly determine if the file
/// has been modified from the version on the file system. See the
/// HTTP 1.1
/// [specification](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html)
/// for HTTP `ETag` headers, which are a very similar concept.
///
/// # Implements
///
/// [`FileExt`][trait@crate::prelude::FileExt], [`FileExtManual`][trait@crate::prelude::FileExtManual]
#[doc(alias = "GFile")]
pub struct File(Interface<ffi::GFile, ffi::GFileIface>);
match fn {
type_ => || ffi::g_file_get_type(),
}
}
impl File {
pub const NONE: Option<&'static File> = None;
//#[doc(alias = "g_file_new_build_filename")]
//pub fn new_build_filename(first_element: impl AsRef<std::path::Path>, : /*Unknown conversion*//*Unimplemented*/Basic: VarArgs) -> File {
// unsafe { TODO: call ffi:g_file_new_build_filename() }
//}
/// Constructs a #GFile from a vector of elements using the correct
/// separator for filenames.
///
/// Using this function is equivalent to calling g_build_filenamev(),
/// followed by g_file_new_for_path() on the result.
/// ## `args`
/// [`None`]-terminated
/// array of strings containing the path elements.
///
/// # Returns
///
/// a new #GFile
#[cfg(feature = "v2_78")]
#[cfg_attr(docsrs, doc(cfg(feature = "v2_78")))]
#[doc(alias = "g_file_new_build_filenamev")]
pub fn new_build_filenamev(args: &[&std::path::Path]) -> File {
unsafe { from_glib_full(ffi::g_file_new_build_filenamev(args.to_glib_none().0)) }
}
/// Creates a #GFile with the given argument from the command line.
/// The value of @arg can be either a URI, an absolute path or a
/// relative path resolved relative to the current working directory.
/// This operation never fails, but the returned object might not
/// support any I/O operation if @arg points to a malformed path.
///
/// Note that on Windows, this function expects its argument to be in
/// UTF-8 -- not the system code page. This means that you
/// should not use this function with string from argv as it is passed
/// to main(). g_win32_get_command_line() will return a UTF-8 version of
/// the commandline. #GApplication also uses UTF-8 but
/// g_application_command_line_create_file_for_arg() may be more useful
/// for you there. It is also always possible to use this function with
/// #GOptionContext arguments of type [`glib::OptionArg::Filename`][crate::glib::OptionArg::Filename].
/// ## `arg`
/// a command line string
///
/// # Returns
///
/// a new #GFile.
/// Free the returned object with g_object_unref().
#[doc(alias = "g_file_new_for_commandline_arg")]
#[doc(alias = "new_for_commandline_arg")]
pub fn for_commandline_arg(arg: impl AsRef<std::ffi::OsStr>) -> File {
unsafe {
from_glib_full(ffi::g_file_new_for_commandline_arg(
arg.as_ref().to_glib_none().0,
))
}
}
/// Creates a #GFile with the given argument from the command line.
///
/// This function is similar to g_file_new_for_commandline_arg() except
/// that it allows for passing the current working directory as an
/// argument instead of using the current working directory of the
/// process.
///
/// This is useful if the commandline argument was given in a context
/// other than the invocation of the current process.
///
/// See also g_application_command_line_create_file_for_arg().
/// ## `arg`
/// a command line string
/// ## `cwd`
/// the current working directory of the commandline
///
/// # Returns
///
/// a new #GFile
#[doc(alias = "g_file_new_for_commandline_arg_and_cwd")]
#[doc(alias = "new_for_commandline_arg_and_cwd")]
pub fn for_commandline_arg_and_cwd(
arg: impl AsRef<std::ffi::OsStr>,
cwd: impl AsRef<std::path::Path>,
) -> File {
unsafe {
from_glib_full(ffi::g_file_new_for_commandline_arg_and_cwd(
arg.as_ref().to_glib_none().0,
cwd.as_ref().to_glib_none().0,
))
}
}
/// Constructs a #GFile for a given path. This operation never
/// fails, but the returned object might not support any I/O
/// operation if @path is malformed.
/// ## `path`
/// a string containing a relative or absolute path.
/// The string must be encoded in the glib filename encoding.
///
/// # Returns
///
/// a new #GFile for the given @path.
/// Free the returned object with g_object_unref().
#[doc(alias = "g_file_new_for_path")]
#[doc(alias = "new_for_path")]
pub fn for_path(path: impl AsRef<std::path::Path>) -> File {
unsafe { from_glib_full(ffi::g_file_new_for_path(path.as_ref().to_glib_none().0)) }
}
/// Constructs a #GFile for a given URI. This operation never
/// fails, but the returned object might not support any I/O
/// operation if @uri is malformed or if the uri type is
/// not supported.
/// ## `uri`
/// a UTF-8 string containing a URI
///
/// # Returns
///
/// a new #GFile for the given @uri.
/// Free the returned object with g_object_unref().
#[doc(alias = "g_file_new_for_uri")]
#[doc(alias = "new_for_uri")]
pub fn for_uri(uri: &str) -> File {
unsafe { from_glib_full(ffi::g_file_new_for_uri(uri.to_glib_none().0)) }
}
/// Opens a file in the preferred directory for temporary files (as
/// returned by g_get_tmp_dir()) and returns a #GFile and
/// #GFileIOStream pointing to it.
///
/// @tmpl should be a string in the GLib file name encoding
/// containing a sequence of six 'X' characters, and containing no
/// directory components. If it is [`None`], a default template is used.
///
/// Unlike the other #GFile constructors, this will return [`None`] if
/// a temporary file could not be created.
/// ## `tmpl`
/// Template for the file
/// name, as in g_file_open_tmp(), or [`None`] for a default template
///
/// # Returns
///
/// a new #GFile.
/// Free the returned object with g_object_unref().
///
/// ## `iostream`
/// on return, a #GFileIOStream for the created file
#[doc(alias = "g_file_new_tmp")]
pub fn new_tmp(
tmpl: Option<impl AsRef<std::path::Path>>,
) -> Result<(File, FileIOStream), glib::Error> {
unsafe {
let mut iostream = std::ptr::null_mut();
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_new_tmp(
tmpl.as_ref().map(|p| p.as_ref()).to_glib_none().0,
&mut iostream,
&mut error,
);
if error.is_null() {
Ok((from_glib_full(ret), from_glib_full(iostream)))
} else {
Err(from_glib_full(error))
}
}
}
/// Constructs a #GFile with the given @parse_name (i.e. something
/// given by g_file_get_parse_name()). This operation never fails,
/// but the returned object might not support any I/O operation if
/// the @parse_name cannot be parsed.
/// ## `parse_name`
/// a file name or path to be parsed
///
/// # Returns
///
/// a new #GFile.
#[doc(alias = "g_file_parse_name")]
#[doc(alias = "parse_name")]
pub fn for_parse_name(parse_name: &str) -> File {
unsafe { from_glib_full(ffi::g_file_parse_name(parse_name.to_glib_none().0)) }
}
}
unsafe impl Send for File {}
unsafe impl Sync for File {}
mod sealed {
pub trait Sealed {}
impl<T: super::IsA<super::File>> Sealed for T {}
}
/// Trait containing all [`struct@File`] methods.
///
/// # Implementors
///
/// [`File`][struct@crate::File]
pub trait FileExt: IsA<File> + sealed::Sealed + 'static {
/// Gets an output stream for appending data to the file.
/// If the file doesn't already exist it is created.
///
/// By default files created are generally readable by everyone,
/// but if you pass [`FileCreateFlags::PRIVATE`][crate::FileCreateFlags::PRIVATE] in @flags the file
/// will be made readable only to the current user, to the level that
/// is supported on the target filesystem.
///
/// If @cancellable is not [`None`], then the operation can be cancelled
/// by triggering the cancellable object from another thread. If the
/// operation was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be
/// returned.
///
/// Some file systems don't allow all file names, and may return an
/// [`IOErrorEnum::InvalidFilename`][crate::IOErrorEnum::InvalidFilename] error. If the file is a directory the
/// [`IOErrorEnum::IsDirectory`][crate::IOErrorEnum::IsDirectory] error will be returned. Other errors are
/// possible too, and depend on what kind of filesystem the file is on.
/// ## `flags`
/// a set of #GFileCreateFlags
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// a #GFileOutputStream, or [`None`] on error.
/// Free the returned object with g_object_unref().
#[doc(alias = "g_file_append_to")]
fn append_to(
&self,
flags: FileCreateFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<FileOutputStream, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_append_to(
self.as_ref().to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Asynchronously opens @self for appending.
///
/// For more details, see g_file_append_to() which is
/// the synchronous version of this call.
///
/// When the operation is finished, @callback will be called.
/// You can then call g_file_append_to_finish() to get the result
/// of the operation.
/// ## `flags`
/// a set of #GFileCreateFlags
/// ## `io_priority`
/// the [I/O priority](iface.AsyncResult.html#io-priority) of the request
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback
/// to call when the request is satisfied
#[doc(alias = "g_file_append_to_async")]
fn append_to_async<P: FnOnce(Result<FileOutputStream, glib::Error>) + 'static>(
&self,
flags: FileCreateFlags,
io_priority: glib::Priority,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn append_to_async_trampoline<
P: FnOnce(Result<FileOutputStream, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_append_to_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = append_to_async_trampoline::<P>;
unsafe {
ffi::g_file_append_to_async(
self.as_ref().to_glib_none().0,
flags.into_glib(),
io_priority.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn append_to_future(
&self,
flags: FileCreateFlags,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<FileOutputStream, glib::Error>> + 'static>>
{
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.append_to_async(flags, io_priority, Some(cancellable), move |res| {
send.resolve(res);
});
},
))
}
#[cfg(feature = "v2_68")]
#[cfg_attr(docsrs, doc(cfg(feature = "v2_68")))]
#[doc(alias = "g_file_build_attribute_list_for_copy")]
fn build_attribute_list_for_copy(
&self,
flags: FileCopyFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<glib::GString, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_build_attribute_list_for_copy(
self.as_ref().to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
#[doc(alias = "g_file_copy")]
fn copy(
&self,
destination: &impl IsA<File>,
flags: FileCopyFlags,
cancellable: Option<&impl IsA<Cancellable>>,
progress_callback: Option<&mut dyn (FnMut(i64, i64))>,
) -> Result<(), glib::Error> {
let mut progress_callback_data: Option<&mut dyn (FnMut(i64, i64))> = progress_callback;
unsafe extern "C" fn progress_callback_func(
current_num_bytes: i64,
total_num_bytes: i64,
data: glib::ffi::gpointer,
) {
let callback = data as *mut Option<&mut dyn (FnMut(i64, i64))>;
if let Some(ref mut callback) = *callback {
callback(current_num_bytes, total_num_bytes)
} else {
panic!("cannot get closure...")
}
}
let progress_callback = if progress_callback_data.is_some() {
Some(progress_callback_func as _)
} else {
None
};
let super_callback0: &mut Option<&mut dyn (FnMut(i64, i64))> = &mut progress_callback_data;
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_file_copy(
self.as_ref().to_glib_none().0,
destination.as_ref().to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
progress_callback,
super_callback0 as *mut _ as *mut _,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Copies the file attributes from @self to @destination.
///
/// Normally only a subset of the file attributes are copied,
/// those that are copies in a normal file copy operation
/// (which for instance does not include e.g. owner). However
/// if [`FileCopyFlags::ALL_METADATA`][crate::FileCopyFlags::ALL_METADATA] is specified in @flags, then
/// all the metadata that is possible to copy is copied. This
/// is useful when implementing move by copy + delete source.
/// ## `destination`
/// a #GFile to copy attributes to
/// ## `flags`
/// a set of #GFileCopyFlags
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// [`true`] if the attributes were copied successfully,
/// [`false`] otherwise.
#[doc(alias = "g_file_copy_attributes")]
fn copy_attributes(
&self,
destination: &impl IsA<File>,
flags: FileCopyFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_file_copy_attributes(
self.as_ref().to_glib_none().0,
destination.as_ref().to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Creates a new file and returns an output stream for writing to it.
/// The file must not already exist.
///
/// By default files created are generally readable by everyone,
/// but if you pass [`FileCreateFlags::PRIVATE`][crate::FileCreateFlags::PRIVATE] in @flags the file
/// will be made readable only to the current user, to the level
/// that is supported on the target filesystem.
///
/// If @cancellable is not [`None`], then the operation can be cancelled
/// by triggering the cancellable object from another thread. If the
/// operation was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be
/// returned.
///
/// If a file or directory with this name already exists the
/// [`IOErrorEnum::Exists`][crate::IOErrorEnum::Exists] error will be returned. Some file systems don't
/// allow all file names, and may return an [`IOErrorEnum::InvalidFilename`][crate::IOErrorEnum::InvalidFilename]
/// error, and if the name is to long [`IOErrorEnum::FilenameTooLong`][crate::IOErrorEnum::FilenameTooLong] will
/// be returned. Other errors are possible too, and depend on what kind
/// of filesystem the file is on.
/// ## `flags`
/// a set of #GFileCreateFlags
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// a #GFileOutputStream for the newly created
/// file, or [`None`] on error.
/// Free the returned object with g_object_unref().
#[doc(alias = "g_file_create")]
fn create(
&self,
flags: FileCreateFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<FileOutputStream, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_create(
self.as_ref().to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Asynchronously creates a new file and returns an output stream
/// for writing to it. The file must not already exist.
///
/// For more details, see g_file_create() which is
/// the synchronous version of this call.
///
/// When the operation is finished, @callback will be called.
/// You can then call g_file_create_finish() to get the result
/// of the operation.
/// ## `flags`
/// a set of #GFileCreateFlags
/// ## `io_priority`
/// the [I/O priority](iface.AsyncResult.html#io-priority) of the request
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback
/// to call when the request is satisfied
#[doc(alias = "g_file_create_async")]
fn create_async<P: FnOnce(Result<FileOutputStream, glib::Error>) + 'static>(
&self,
flags: FileCreateFlags,
io_priority: glib::Priority,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn create_async_trampoline<
P: FnOnce(Result<FileOutputStream, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_create_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = create_async_trampoline::<P>;
unsafe {
ffi::g_file_create_async(
self.as_ref().to_glib_none().0,
flags.into_glib(),
io_priority.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn create_future(
&self,
flags: FileCreateFlags,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<FileOutputStream, glib::Error>> + 'static>>
{
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.create_async(flags, io_priority, Some(cancellable), move |res| {
send.resolve(res);
});
},
))
}
/// Creates a new file and returns a stream for reading and
/// writing to it. The file must not already exist.
///
/// By default files created are generally readable by everyone,
/// but if you pass [`FileCreateFlags::PRIVATE`][crate::FileCreateFlags::PRIVATE] in @flags the file
/// will be made readable only to the current user, to the level
/// that is supported on the target filesystem.
///
/// If @cancellable is not [`None`], then the operation can be cancelled
/// by triggering the cancellable object from another thread. If the
/// operation was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be
/// returned.
///
/// If a file or directory with this name already exists, the
/// [`IOErrorEnum::Exists`][crate::IOErrorEnum::Exists] error will be returned. Some file systems don't
/// allow all file names, and may return an [`IOErrorEnum::InvalidFilename`][crate::IOErrorEnum::InvalidFilename]
/// error, and if the name is too long, [`IOErrorEnum::FilenameTooLong`][crate::IOErrorEnum::FilenameTooLong]
/// will be returned. Other errors are possible too, and depend on what
/// kind of filesystem the file is on.
///
/// Note that in many non-local file cases read and write streams are
/// not supported, so make sure you really need to do read and write
/// streaming, rather than just opening for reading or writing.
/// ## `flags`
/// a set of #GFileCreateFlags
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// a #GFileIOStream for the newly created
/// file, or [`None`] on error.
/// Free the returned object with g_object_unref().
#[doc(alias = "g_file_create_readwrite")]
fn create_readwrite(
&self,
flags: FileCreateFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<FileIOStream, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_create_readwrite(
self.as_ref().to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Asynchronously creates a new file and returns a stream
/// for reading and writing to it. The file must not already exist.
///
/// For more details, see g_file_create_readwrite() which is
/// the synchronous version of this call.
///
/// When the operation is finished, @callback will be called.
/// You can then call g_file_create_readwrite_finish() to get
/// the result of the operation.
/// ## `flags`
/// a set of #GFileCreateFlags
/// ## `io_priority`
/// the [I/O priority](iface.AsyncResult.html#io-priority) of the request
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback
/// to call when the request is satisfied
#[doc(alias = "g_file_create_readwrite_async")]
fn create_readwrite_async<P: FnOnce(Result<FileIOStream, glib::Error>) + 'static>(
&self,
flags: FileCreateFlags,
io_priority: glib::Priority,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn create_readwrite_async_trampoline<
P: FnOnce(Result<FileIOStream, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let ret =
ffi::g_file_create_readwrite_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = create_readwrite_async_trampoline::<P>;
unsafe {
ffi::g_file_create_readwrite_async(
self.as_ref().to_glib_none().0,
flags.into_glib(),
io_priority.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn create_readwrite_future(
&self,
flags: FileCreateFlags,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<FileIOStream, glib::Error>> + 'static>>
{
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.create_readwrite_async(flags, io_priority, Some(cancellable), move |res| {
send.resolve(res);
});
},
))
}
/// Deletes a file. If the @self is a directory, it will only be
/// deleted if it is empty. This has the same semantics as g_unlink().
///
/// If @self doesn’t exist, [`IOErrorEnum::NotFound`][crate::IOErrorEnum::NotFound] will be returned. This allows
/// for deletion to be implemented avoiding
/// [time-of-check to time-of-use races](https://en.wikipedia.org/wiki/Time-of-check_to_time-of-use):
///
/// ```text
/// g_autoptr(GError) local_error = NULL;
/// if (!g_file_delete (my_file, my_cancellable, &local_error) &&
/// !g_error_matches (local_error, G_IO_ERROR, G_IO_ERROR_NOT_FOUND))
/// {
/// // deletion failed for some reason other than the file not existing:
/// // so report the error
/// g_warning ("Failed to delete %s: %s",
/// g_file_peek_path (my_file), local_error->message);
/// }
/// ```
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// [`true`] if the file was deleted. [`false`] otherwise.
#[doc(alias = "g_file_delete")]
fn delete(&self, cancellable: Option<&impl IsA<Cancellable>>) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_file_delete(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Asynchronously delete a file. If the @self is a directory, it will
/// only be deleted if it is empty. This has the same semantics as
/// g_unlink().
/// ## `io_priority`
/// the [I/O priority](iface.AsyncResult.html#io-priority) of the request
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback to call
/// when the request is satisfied
#[doc(alias = "g_file_delete_async")]
fn delete_async<P: FnOnce(Result<(), glib::Error>) + 'static>(
&self,
io_priority: glib::Priority,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn delete_async_trampoline<
P: FnOnce(Result<(), glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let _ = ffi::g_file_delete_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = delete_async_trampoline::<P>;
unsafe {
ffi::g_file_delete_async(
self.as_ref().to_glib_none().0,
io_priority.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn delete_future(
&self,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<(), glib::Error>> + 'static>> {
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.delete_async(io_priority, Some(cancellable), move |res| {
send.resolve(res);
});
},
))
}
/// Duplicates a #GFile handle. This operation does not duplicate
/// the actual file or directory represented by the #GFile; see
/// g_file_copy() if attempting to copy a file.
///
/// g_file_dup() is useful when a second handle is needed to the same underlying
/// file, for use in a separate thread (#GFile is not thread-safe). For use
/// within the same thread, use g_object_ref() to increment the existing object’s
/// reference count.
///
/// This call does no blocking I/O.
///
/// # Returns
///
/// a new #GFile that is a duplicate
/// of the given #GFile.
#[doc(alias = "g_file_dup")]
#[must_use]
fn dup(&self) -> File {
unsafe { from_glib_full(ffi::g_file_dup(self.as_ref().to_glib_none().0)) }
}
/// Starts an asynchronous eject on a mountable.
/// When this operation has completed, @callback will be called with
/// @user_user data, and the operation can be finalized with
/// g_file_eject_mountable_with_operation_finish().
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
/// ## `flags`
/// flags affecting the operation
/// ## `mount_operation`
/// a #GMountOperation,
/// or [`None`] to avoid user interaction
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback
/// to call when the request is satisfied
#[doc(alias = "g_file_eject_mountable_with_operation")]
fn eject_mountable_with_operation<P: FnOnce(Result<(), glib::Error>) + 'static>(
&self,
flags: MountUnmountFlags,
mount_operation: Option<&impl IsA<MountOperation>>,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn eject_mountable_with_operation_trampoline<
P: FnOnce(Result<(), glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let _ = ffi::g_file_eject_mountable_with_operation_finish(
_source_object as *mut _,
res,
&mut error,
);
let result = if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = eject_mountable_with_operation_trampoline::<P>;
unsafe {
ffi::g_file_eject_mountable_with_operation(
self.as_ref().to_glib_none().0,
flags.into_glib(),
mount_operation.map(|p| p.as_ref()).to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn eject_mountable_with_operation_future(
&self,
flags: MountUnmountFlags,
mount_operation: Option<&(impl IsA<MountOperation> + Clone + 'static)>,
) -> Pin<Box_<dyn std::future::Future<Output = Result<(), glib::Error>> + 'static>> {
let mount_operation = mount_operation.map(ToOwned::to_owned);
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.eject_mountable_with_operation(
flags,
mount_operation.as_ref().map(::std::borrow::Borrow::borrow),
Some(cancellable),
move |res| {
send.resolve(res);
},
);
},
))
}
/// Gets the requested information about the files in a directory.
/// The result is a #GFileEnumerator object that will give out
/// #GFileInfo objects for all the files in the directory.
///
/// The @attributes value is a string that specifies the file
/// attributes that should be gathered. It is not an error if
/// it's not possible to read a particular requested attribute
/// from a file - it just won't be set. @attributes should
/// be a comma-separated list of attributes or attribute wildcards.
/// The wildcard "*" means all attributes, and a wildcard like
/// "standard::*" means all attributes in the standard namespace.
/// An example attribute query be "standard::*,owner::user".
/// The standard attributes are available as defines, like
/// [`FILE_ATTRIBUTE_STANDARD_NAME`][crate::FILE_ATTRIBUTE_STANDARD_NAME]. [`FILE_ATTRIBUTE_STANDARD_NAME`][crate::FILE_ATTRIBUTE_STANDARD_NAME] should
/// always be specified if you plan to call g_file_enumerator_get_child() or
/// g_file_enumerator_iterate() on the returned enumerator.
///
/// If @cancellable is not [`None`], then the operation can be cancelled
/// by triggering the cancellable object from another thread. If the
/// operation was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be
/// returned.
///
/// If the file does not exist, the [`IOErrorEnum::NotFound`][crate::IOErrorEnum::NotFound] error will
/// be returned. If the file is not a directory, the [`IOErrorEnum::NotDirectory`][crate::IOErrorEnum::NotDirectory]
/// error will be returned. Other errors are possible too.
/// ## `attributes`
/// an attribute query string
/// ## `flags`
/// a set of #GFileQueryInfoFlags
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// A #GFileEnumerator if successful,
/// [`None`] on error. Free the returned object with g_object_unref().
#[doc(alias = "g_file_enumerate_children")]
fn enumerate_children(
&self,
attributes: &str,
flags: FileQueryInfoFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<FileEnumerator, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_enumerate_children(
self.as_ref().to_glib_none().0,
attributes.to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
#[doc(alias = "g_file_equal")]
fn equal(&self, file2: &impl IsA<File>) -> bool {
unsafe {
from_glib(ffi::g_file_equal(
self.as_ref().to_glib_none().0,
file2.as_ref().to_glib_none().0,
))
}
}
/// Gets a #GMount for the #GFile.
///
/// #GMount is returned only for user interesting locations, see
/// #GVolumeMonitor. If the #GFileIface for @self does not have a #mount,
/// @error will be set to [`IOErrorEnum::NotFound`][crate::IOErrorEnum::NotFound] and [`None`] #will be returned.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// a #GMount where the @self is located
/// or [`None`] on error.
/// Free the returned object with g_object_unref().
#[doc(alias = "g_file_find_enclosing_mount")]
fn find_enclosing_mount(
&self,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<Mount, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_find_enclosing_mount(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Gets the base name (the last component of the path) for a given #GFile.
///
/// If called for the top level of a system (such as the filesystem root
/// or a uri like sftp://host/) it will return a single directory separator
/// (and on Windows, possibly a drive letter).
///
/// The base name is a byte string (not UTF-8). It has no defined encoding
/// or rules other than it may not contain zero bytes. If you want to use
/// filenames in a user interface you should use the display name that you
/// can get by requesting the [`FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME`][crate::FILE_ATTRIBUTE_STANDARD_DISPLAY_NAME]
/// attribute with g_file_query_info().
///
/// This call does no blocking I/O.
///
/// # Returns
///
/// string containing the #GFile's
/// base name, or [`None`] if given #GFile is invalid. The returned string
/// should be freed with g_free() when no longer needed.
#[doc(alias = "g_file_get_basename")]
#[doc(alias = "get_basename")]
fn basename(&self) -> Option<std::path::PathBuf> {
unsafe { from_glib_full(ffi::g_file_get_basename(self.as_ref().to_glib_none().0)) }
}
/// Gets a child of @self with basename equal to @name.
///
/// Note that the file with that specific name might not exist, but
/// you can still have a #GFile that points to it. You can use this
/// for instance to create that file.
///
/// This call does no blocking I/O.
/// ## `name`
/// string containing the child's basename
///
/// # Returns
///
/// a #GFile to a child specified by @name.
/// Free the returned object with g_object_unref().
#[doc(alias = "g_file_get_child")]
#[doc(alias = "get_child")]
#[must_use]
fn child(&self, name: impl AsRef<std::path::Path>) -> File {
unsafe {
from_glib_full(ffi::g_file_get_child(
self.as_ref().to_glib_none().0,
name.as_ref().to_glib_none().0,
))
}
}
/// Gets the child of @self for a given @display_name (i.e. a UTF-8
/// version of the name). If this function fails, it returns [`None`]
/// and @error will be set. This is very useful when constructing a
/// #GFile for a new file and the user entered the filename in the
/// user interface, for instance when you select a directory and
/// type a filename in the file selector.
///
/// This call does no blocking I/O.
/// ## `display_name`
/// string to a possible child
///
/// # Returns
///
/// a #GFile to the specified child, or
/// [`None`] if the display name couldn't be converted.
/// Free the returned object with g_object_unref().
#[doc(alias = "g_file_get_child_for_display_name")]
#[doc(alias = "get_child_for_display_name")]
fn child_for_display_name(&self, display_name: &str) -> Result<File, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_get_child_for_display_name(
self.as_ref().to_glib_none().0,
display_name.to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Gets the parent directory for the @self.
/// If the @self represents the root directory of the
/// file system, then [`None`] will be returned.
///
/// This call does no blocking I/O.
///
/// # Returns
///
/// a #GFile structure to the
/// parent of the given #GFile or [`None`] if there is no parent. Free
/// the returned object with g_object_unref().
#[doc(alias = "g_file_get_parent")]
#[doc(alias = "get_parent")]
#[must_use]
fn parent(&self) -> Option<File> {
unsafe { from_glib_full(ffi::g_file_get_parent(self.as_ref().to_glib_none().0)) }
}
/// Gets the parse name of the @self.
/// A parse name is a UTF-8 string that describes the
/// file such that one can get the #GFile back using
/// g_file_parse_name().
///
/// This is generally used to show the #GFile as a nice
/// full-pathname kind of string in a user interface,
/// like in a location entry.
///
/// For local files with names that can safely be converted
/// to UTF-8 the pathname is used, otherwise the IRI is used
/// (a form of URI that allows UTF-8 characters unescaped).
///
/// This call does no blocking I/O.
///
/// # Returns
///
/// a string containing the #GFile's parse name.
/// The returned string should be freed with g_free()
/// when no longer needed.
#[doc(alias = "g_file_get_parse_name")]
#[doc(alias = "get_parse_name")]
fn parse_name(&self) -> glib::GString {
unsafe { from_glib_full(ffi::g_file_get_parse_name(self.as_ref().to_glib_none().0)) }
}
/// Gets the local pathname for #GFile, if one exists. If non-[`None`], this is
/// guaranteed to be an absolute, canonical path. It might contain symlinks.
///
/// This call does no blocking I/O.
///
/// # Returns
///
/// string containing the #GFile's path,
/// or [`None`] if no such path exists. The returned string should be freed
/// with g_free() when no longer needed.
#[doc(alias = "g_file_get_path")]
#[doc(alias = "get_path")]
fn path(&self) -> Option<std::path::PathBuf> {
unsafe { from_glib_full(ffi::g_file_get_path(self.as_ref().to_glib_none().0)) }
}
/// Gets the path for @descendant relative to @self.
///
/// This call does no blocking I/O.
/// ## `descendant`
/// input #GFile
///
/// # Returns
///
/// string with the relative path from
/// @descendant to @self, or [`None`] if @descendant doesn't have @self as
/// prefix. The returned string should be freed with g_free() when
/// no longer needed.
#[doc(alias = "g_file_get_relative_path")]
#[doc(alias = "get_relative_path")]
fn relative_path(&self, descendant: &impl IsA<File>) -> Option<std::path::PathBuf> {
unsafe {
from_glib_full(ffi::g_file_get_relative_path(
self.as_ref().to_glib_none().0,
descendant.as_ref().to_glib_none().0,
))
}
}
/// Gets the URI for the @self.
///
/// This call does no blocking I/O.
///
/// # Returns
///
/// a string containing the #GFile's URI. If the #GFile was constructed
/// with an invalid URI, an invalid URI is returned.
/// The returned string should be freed with g_free()
/// when no longer needed.
#[doc(alias = "g_file_get_uri")]
#[doc(alias = "get_uri")]
fn uri(&self) -> glib::GString {
unsafe { from_glib_full(ffi::g_file_get_uri(self.as_ref().to_glib_none().0)) }
}
/// Gets the URI scheme for a #GFile.
/// RFC 3986 decodes the scheme as:
///
/// ```text
/// URI = scheme ":" hier-part [ "?" query ] [ "#" fragment ]
/// ```
/// Common schemes include "file", "http", "ftp", etc.
///
/// The scheme can be different from the one used to construct the #GFile,
/// in that it might be replaced with one that is logically equivalent to the #GFile.
///
/// This call does no blocking I/O.
///
/// # Returns
///
/// a string containing the URI scheme for the given
/// #GFile or [`None`] if the #GFile was constructed with an invalid URI. The
/// returned string should be freed with g_free() when no longer needed.
#[doc(alias = "g_file_get_uri_scheme")]
#[doc(alias = "get_uri_scheme")]
fn uri_scheme(&self) -> Option<glib::GString> {
unsafe { from_glib_full(ffi::g_file_get_uri_scheme(self.as_ref().to_glib_none().0)) }
}
/// Checks if @self has a parent, and optionally, if it is @parent.
///
/// If @parent is [`None`] then this function returns [`true`] if @self has any
/// parent at all. If @parent is non-[`None`] then [`true`] is only returned
/// if @self is an immediate child of @parent.
/// ## `parent`
/// the parent to check for, or [`None`]
///
/// # Returns
///
/// [`true`] if @self is an immediate child of @parent (or any parent in
/// the case that @parent is [`None`]).
#[doc(alias = "g_file_has_parent")]
fn has_parent(&self, parent: Option<&impl IsA<File>>) -> bool {
unsafe {
from_glib(ffi::g_file_has_parent(
self.as_ref().to_glib_none().0,
parent.map(|p| p.as_ref()).to_glib_none().0,
))
}
}
/// Checks whether @self has the prefix specified by @prefix.
///
/// In other words, if the names of initial elements of @self's
/// pathname match @prefix. Only full pathname elements are matched,
/// so a path like /foo is not considered a prefix of /foobar, only
/// of /foo/bar.
///
/// A #GFile is not a prefix of itself. If you want to check for
/// equality, use g_file_equal().
///
/// This call does no I/O, as it works purely on names. As such it can
/// sometimes return [`false`] even if @self is inside a @prefix (from a
/// filesystem point of view), because the prefix of @self is an alias
/// of @prefix.
/// ## `prefix`
/// input #GFile
///
/// # Returns
///
/// [`true`] if the @self's parent, grandparent, etc is @prefix,
/// [`false`] otherwise.
#[doc(alias = "g_file_has_prefix")]
fn has_prefix(&self, prefix: &impl IsA<File>) -> bool {
unsafe {
from_glib(ffi::g_file_has_prefix(
self.as_ref().to_glib_none().0,
prefix.as_ref().to_glib_none().0,
))
}
}
/// Checks to see if a #GFile has a given URI scheme.
///
/// This call does no blocking I/O.
/// ## `uri_scheme`
/// a string containing a URI scheme
///
/// # Returns
///
/// [`true`] if #GFile's backend supports the
/// given URI scheme, [`false`] if URI scheme is [`None`],
/// not supported, or #GFile is invalid.
#[doc(alias = "g_file_has_uri_scheme")]
fn has_uri_scheme(&self, uri_scheme: &str) -> bool {
unsafe {
from_glib(ffi::g_file_has_uri_scheme(
self.as_ref().to_glib_none().0,
uri_scheme.to_glib_none().0,
))
}
}
/// Checks to see if a file is native to the platform.
///
/// A native file is one expressed in the platform-native filename format,
/// e.g. "C:\Windows" or "/usr/bin/". This does not mean the file is local,
/// as it might be on a locally mounted remote filesystem.
///
/// On some systems non-native files may be available using the native
/// filesystem via a userspace filesystem (FUSE), in these cases this call
/// will return [`false`], but g_file_get_path() will still return a native path.
///
/// This call does no blocking I/O.
///
/// # Returns
///
/// [`true`] if @self is native
#[doc(alias = "g_file_is_native")]
fn is_native(&self) -> bool {
unsafe { from_glib(ffi::g_file_is_native(self.as_ref().to_glib_none().0)) }
}
/// Loads the contents of @self and returns it as #GBytes.
///
/// If @self is a resource:// based URI, the resulting bytes will reference the
/// embedded resource instead of a copy. Otherwise, this is equivalent to calling
/// g_file_load_contents() and g_bytes_new_take().
///
/// For resources, @etag_out will be set to [`None`].
///
/// The data contained in the resulting #GBytes is always zero-terminated, but
/// this is not included in the #GBytes length. The resulting #GBytes should be
/// freed with g_bytes_unref() when no longer in use.
/// ## `cancellable`
/// a #GCancellable or [`None`]
///
/// # Returns
///
/// a #GBytes or [`None`] and @error is set
///
/// ## `etag_out`
/// a location to place the current
/// entity tag for the file, or [`None`] if the entity tag is not needed
#[doc(alias = "g_file_load_bytes")]
fn load_bytes(
&self,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(glib::Bytes, Option<glib::GString>), glib::Error> {
unsafe {
let mut etag_out = std::ptr::null_mut();
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_load_bytes(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut etag_out,
&mut error,
);
if error.is_null() {
Ok((from_glib_full(ret), from_glib_full(etag_out)))
} else {
Err(from_glib_full(error))
}
}
}
/// Asynchronously loads the contents of @self as #GBytes.
///
/// If @self is a resource:// based URI, the resulting bytes will reference the
/// embedded resource instead of a copy. Otherwise, this is equivalent to calling
/// g_file_load_contents_async() and g_bytes_new_take().
///
/// @callback should call g_file_load_bytes_finish() to get the result of this
/// asynchronous operation.
///
/// See g_file_load_bytes() for more information.
/// ## `cancellable`
/// a #GCancellable or [`None`]
/// ## `callback`
/// a #GAsyncReadyCallback
/// to call when the request is satisfied
#[doc(alias = "g_file_load_bytes_async")]
fn load_bytes_async<
P: FnOnce(Result<(glib::Bytes, Option<glib::GString>), glib::Error>) + 'static,
>(
&self,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn load_bytes_async_trampoline<
P: FnOnce(Result<(glib::Bytes, Option<glib::GString>), glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let mut etag_out = std::ptr::null_mut();
let ret = ffi::g_file_load_bytes_finish(
_source_object as *mut _,
res,
&mut etag_out,
&mut error,
);
let result = if error.is_null() {
Ok((from_glib_full(ret), from_glib_full(etag_out)))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = load_bytes_async_trampoline::<P>;
unsafe {
ffi::g_file_load_bytes_async(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn load_bytes_future(
&self,
) -> Pin<
Box_<
dyn std::future::Future<
Output = Result<(glib::Bytes, Option<glib::GString>), glib::Error>,
> + 'static,
>,
> {
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.load_bytes_async(Some(cancellable), move |res| {
send.resolve(res);
});
},
))
}
/// Creates a directory. Note that this will only create a child directory
/// of the immediate parent directory of the path or URI given by the #GFile.
/// To recursively create directories, see g_file_make_directory_with_parents().
/// This function will fail if the parent directory does not exist, setting
/// @error to [`IOErrorEnum::NotFound`][crate::IOErrorEnum::NotFound]. If the file system doesn't support
/// creating directories, this function will fail, setting @error to
/// [`IOErrorEnum::NotSupported`][crate::IOErrorEnum::NotSupported].
///
/// For a local #GFile the newly created directory will have the default
/// (current) ownership and permissions of the current process.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// [`true`] on successful creation, [`false`] otherwise.
#[doc(alias = "g_file_make_directory")]
fn make_directory(
&self,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_file_make_directory(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Asynchronously creates a directory.
/// ## `io_priority`
/// the [I/O priority](iface.AsyncResult.html#io-priority) of the request
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback to call
/// when the request is satisfied
#[doc(alias = "g_file_make_directory_async")]
fn make_directory_async<P: FnOnce(Result<(), glib::Error>) + 'static>(
&self,
io_priority: glib::Priority,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn make_directory_async_trampoline<
P: FnOnce(Result<(), glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let _ = ffi::g_file_make_directory_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = make_directory_async_trampoline::<P>;
unsafe {
ffi::g_file_make_directory_async(
self.as_ref().to_glib_none().0,
io_priority.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn make_directory_future(
&self,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<(), glib::Error>> + 'static>> {
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.make_directory_async(io_priority, Some(cancellable), move |res| {
send.resolve(res);
});
},
))
}
/// Creates a directory and any parent directories that may not
/// exist similar to 'mkdir -p'. If the file system does not support
/// creating directories, this function will fail, setting @error to
/// [`IOErrorEnum::NotSupported`][crate::IOErrorEnum::NotSupported]. If the directory itself already exists,
/// this function will fail setting @error to [`IOErrorEnum::Exists`][crate::IOErrorEnum::Exists], unlike
/// the similar g_mkdir_with_parents().
///
/// For a local #GFile the newly created directories will have the default
/// (current) ownership and permissions of the current process.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// [`true`] if all directories have been successfully created, [`false`]
/// otherwise.
#[doc(alias = "g_file_make_directory_with_parents")]
fn make_directory_with_parents(
&self,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_file_make_directory_with_parents(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Creates a symbolic link named @self which contains the string
/// @symlink_value.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
/// ## `symlink_value`
/// a string with the path for the target
/// of the new symlink
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// [`true`] on the creation of a new symlink, [`false`] otherwise.
#[doc(alias = "g_file_make_symbolic_link")]
fn make_symbolic_link(
&self,
symlink_value: impl AsRef<std::path::Path>,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_file_make_symbolic_link(
self.as_ref().to_glib_none().0,
symlink_value.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Obtains a file or directory monitor for the given file,
/// depending on the type of the file.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
/// ## `flags`
/// a set of #GFileMonitorFlags
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// a #GFileMonitor for the given @self,
/// or [`None`] on error.
/// Free the returned object with g_object_unref().
#[doc(alias = "g_file_monitor")]
fn monitor(
&self,
flags: FileMonitorFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<FileMonitor, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_monitor(
self.as_ref().to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Obtains a directory monitor for the given file.
/// This may fail if directory monitoring is not supported.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
///
/// It does not make sense for @flags to contain
/// [`FileMonitorFlags::WATCH_HARD_LINKS`][crate::FileMonitorFlags::WATCH_HARD_LINKS], since hard links can not be made to
/// directories. It is not possible to monitor all the files in a
/// directory for changes made via hard links; if you want to do this then
/// you must register individual watches with g_file_monitor().
/// ## `flags`
/// a set of #GFileMonitorFlags
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// a #GFileMonitor for the given @self,
/// or [`None`] on error. Free the returned object with g_object_unref().
#[doc(alias = "g_file_monitor_directory")]
fn monitor_directory(
&self,
flags: FileMonitorFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<FileMonitor, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_monitor_directory(
self.as_ref().to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Obtains a file monitor for the given file. If no file notification
/// mechanism exists, then regular polling of the file is used.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
///
/// If @flags contains [`FileMonitorFlags::WATCH_HARD_LINKS`][crate::FileMonitorFlags::WATCH_HARD_LINKS] then the monitor
/// will also attempt to report changes made to the file via another
/// filename (ie, a hard link). Without this flag, you can only rely on
/// changes made through the filename contained in @self to be
/// reported. Using this flag may result in an increase in resource
/// usage, and may not have any effect depending on the #GFileMonitor
/// backend and/or filesystem type.
/// ## `flags`
/// a set of #GFileMonitorFlags
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// a #GFileMonitor for the given @self,
/// or [`None`] on error.
/// Free the returned object with g_object_unref().
#[doc(alias = "g_file_monitor_file")]
fn monitor_file(
&self,
flags: FileMonitorFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<FileMonitor, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_monitor_file(
self.as_ref().to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Starts a @mount_operation, mounting the volume that contains
/// the file @self.
///
/// When this operation has completed, @callback will be called with
/// @user_user data, and the operation can be finalized with
/// g_file_mount_enclosing_volume_finish().
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
/// ## `flags`
/// flags affecting the operation
/// ## `mount_operation`
/// a #GMountOperation
/// or [`None`] to avoid user interaction
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback to call
/// when the request is satisfied, or [`None`]
#[doc(alias = "g_file_mount_enclosing_volume")]
fn mount_enclosing_volume<P: FnOnce(Result<(), glib::Error>) + 'static>(
&self,
flags: MountMountFlags,
mount_operation: Option<&impl IsA<MountOperation>>,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn mount_enclosing_volume_trampoline<
P: FnOnce(Result<(), glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let _ = ffi::g_file_mount_enclosing_volume_finish(
_source_object as *mut _,
res,
&mut error,
);
let result = if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = mount_enclosing_volume_trampoline::<P>;
unsafe {
ffi::g_file_mount_enclosing_volume(
self.as_ref().to_glib_none().0,
flags.into_glib(),
mount_operation.map(|p| p.as_ref()).to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn mount_enclosing_volume_future(
&self,
flags: MountMountFlags,
mount_operation: Option<&(impl IsA<MountOperation> + Clone + 'static)>,
) -> Pin<Box_<dyn std::future::Future<Output = Result<(), glib::Error>> + 'static>> {
let mount_operation = mount_operation.map(ToOwned::to_owned);
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.mount_enclosing_volume(
flags,
mount_operation.as_ref().map(::std::borrow::Borrow::borrow),
Some(cancellable),
move |res| {
send.resolve(res);
},
);
},
))
}
/// Mounts a file of type G_FILE_TYPE_MOUNTABLE.
/// Using @mount_operation, you can request callbacks when, for instance,
/// passwords are needed during authentication.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
///
/// When the operation is finished, @callback will be called.
/// You can then call g_file_mount_mountable_finish() to get
/// the result of the operation.
/// ## `flags`
/// flags affecting the operation
/// ## `mount_operation`
/// a #GMountOperation,
/// or [`None`] to avoid user interaction
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback
/// to call when the request is satisfied
#[doc(alias = "g_file_mount_mountable")]
fn mount_mountable<P: FnOnce(Result<File, glib::Error>) + 'static>(
&self,
flags: MountMountFlags,
mount_operation: Option<&impl IsA<MountOperation>>,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn mount_mountable_trampoline<
P: FnOnce(Result<File, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_mount_mountable_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = mount_mountable_trampoline::<P>;
unsafe {
ffi::g_file_mount_mountable(
self.as_ref().to_glib_none().0,
flags.into_glib(),
mount_operation.map(|p| p.as_ref()).to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn mount_mountable_future(
&self,
flags: MountMountFlags,
mount_operation: Option<&(impl IsA<MountOperation> + Clone + 'static)>,
) -> Pin<Box_<dyn std::future::Future<Output = Result<File, glib::Error>> + 'static>> {
let mount_operation = mount_operation.map(ToOwned::to_owned);
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.mount_mountable(
flags,
mount_operation.as_ref().map(::std::borrow::Borrow::borrow),
Some(cancellable),
move |res| {
send.resolve(res);
},
);
},
))
}
/// Tries to move the file or directory @self to the location specified
/// by @destination. If native move operations are supported then this is
/// used, otherwise a copy + delete fallback is used. The native
/// implementation may support moving directories (for instance on moves
/// inside the same filesystem), but the fallback code does not.
///
/// If the flag [`FileCopyFlags::OVERWRITE`][crate::FileCopyFlags::OVERWRITE] is specified an already
/// existing @destination file is overwritten.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
///
/// If @progress_callback is not [`None`], then the operation can be monitored
/// by setting this to a #GFileProgressCallback function.
/// @progress_callback_data will be passed to this function. It is
/// guaranteed that this callback will be called after all data has been
/// transferred with the total number of bytes copied during the operation.
///
/// If the @self file does not exist, then the [`IOErrorEnum::NotFound`][crate::IOErrorEnum::NotFound]
/// error is returned, independent on the status of the @destination.
///
/// If [`FileCopyFlags::OVERWRITE`][crate::FileCopyFlags::OVERWRITE] is not specified and the target exists,
/// then the error [`IOErrorEnum::Exists`][crate::IOErrorEnum::Exists] is returned.
///
/// If trying to overwrite a file over a directory, the [`IOErrorEnum::IsDirectory`][crate::IOErrorEnum::IsDirectory]
/// error is returned. If trying to overwrite a directory with a directory the
/// [`IOErrorEnum::WouldMerge`][crate::IOErrorEnum::WouldMerge] error is returned.
///
/// If the source is a directory and the target does not exist, or
/// [`FileCopyFlags::OVERWRITE`][crate::FileCopyFlags::OVERWRITE] is specified and the target is a file, then
/// the [`IOErrorEnum::WouldRecurse`][crate::IOErrorEnum::WouldRecurse] error may be returned (if the native
/// move operation isn't available).
/// ## `destination`
/// #GFile pointing to the destination location
/// ## `flags`
/// set of #GFileCopyFlags
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
/// ## `progress_callback`
/// #GFileProgressCallback
/// function for updates
/// ## `progress_callback_data`
/// gpointer to user data for
/// the callback function
///
/// # Returns
///
/// [`true`] on successful move, [`false`] otherwise.
#[doc(alias = "g_file_move")]
#[doc(alias = "move")]
fn move_(
&self,
destination: &impl IsA<File>,
flags: FileCopyFlags,
cancellable: Option<&impl IsA<Cancellable>>,
progress_callback: Option<&mut dyn (FnMut(i64, i64))>,
) -> Result<(), glib::Error> {
let mut progress_callback_data: Option<&mut dyn (FnMut(i64, i64))> = progress_callback;
unsafe extern "C" fn progress_callback_func(
current_num_bytes: i64,
total_num_bytes: i64,
data: glib::ffi::gpointer,
) {
let callback = data as *mut Option<&mut dyn (FnMut(i64, i64))>;
if let Some(ref mut callback) = *callback {
callback(current_num_bytes, total_num_bytes)
} else {
panic!("cannot get closure...")
}
}
let progress_callback = if progress_callback_data.is_some() {
Some(progress_callback_func as _)
} else {
None
};
let super_callback0: &mut Option<&mut dyn (FnMut(i64, i64))> = &mut progress_callback_data;
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_file_move(
self.as_ref().to_glib_none().0,
destination.as_ref().to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
progress_callback,
super_callback0 as *mut _ as *mut _,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Opens an existing file for reading and writing. The result is
/// a #GFileIOStream that can be used to read and write the contents
/// of the file.
///
/// If @cancellable is not [`None`], then the operation can be cancelled
/// by triggering the cancellable object from another thread. If the
/// operation was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be
/// returned.
///
/// If the file does not exist, the [`IOErrorEnum::NotFound`][crate::IOErrorEnum::NotFound] error will
/// be returned. If the file is a directory, the [`IOErrorEnum::IsDirectory`][crate::IOErrorEnum::IsDirectory]
/// error will be returned. Other errors are possible too, and depend on
/// what kind of filesystem the file is on. Note that in many non-local
/// file cases read and write streams are not supported, so make sure you
/// really need to do read and write streaming, rather than just opening
/// for reading or writing.
/// ## `cancellable`
/// a #GCancellable
///
/// # Returns
///
/// #GFileIOStream or [`None`] on error.
/// Free the returned object with g_object_unref().
#[doc(alias = "g_file_open_readwrite")]
fn open_readwrite(
&self,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<FileIOStream, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_open_readwrite(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Asynchronously opens @self for reading and writing.
///
/// For more details, see g_file_open_readwrite() which is
/// the synchronous version of this call.
///
/// When the operation is finished, @callback will be called.
/// You can then call g_file_open_readwrite_finish() to get
/// the result of the operation.
/// ## `io_priority`
/// the [I/O priority](iface.AsyncResult.html#io-priority) of the request
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback
/// to call when the request is satisfied
#[doc(alias = "g_file_open_readwrite_async")]
fn open_readwrite_async<P: FnOnce(Result<FileIOStream, glib::Error>) + 'static>(
&self,
io_priority: glib::Priority,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn open_readwrite_async_trampoline<
P: FnOnce(Result<FileIOStream, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_open_readwrite_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = open_readwrite_async_trampoline::<P>;
unsafe {
ffi::g_file_open_readwrite_async(
self.as_ref().to_glib_none().0,
io_priority.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn open_readwrite_future(
&self,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<FileIOStream, glib::Error>> + 'static>>
{
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.open_readwrite_async(io_priority, Some(cancellable), move |res| {
send.resolve(res);
});
},
))
}
/// Exactly like g_file_get_path(), but caches the result via
/// g_object_set_qdata_full(). This is useful for example in C
/// applications which mix `g_file_*` APIs with native ones. It
/// also avoids an extra duplicated string when possible, so will be
/// generally more efficient.
///
/// This call does no blocking I/O.
///
/// # Returns
///
/// string containing the #GFile's path,
/// or [`None`] if no such path exists. The returned string is owned by @self.
#[doc(alias = "g_file_peek_path")]
fn peek_path(&self) -> Option<std::path::PathBuf> {
unsafe { from_glib_none(ffi::g_file_peek_path(self.as_ref().to_glib_none().0)) }
}
/// Polls a file of type [`FileType::Mountable`][crate::FileType::Mountable].
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
///
/// When the operation is finished, @callback will be called.
/// You can then call g_file_mount_mountable_finish() to get
/// the result of the operation.
/// ## `cancellable`
/// optional #GCancellable object, [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback to call
/// when the request is satisfied, or [`None`]
#[doc(alias = "g_file_poll_mountable")]
fn poll_mountable<P: FnOnce(Result<(), glib::Error>) + 'static>(
&self,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn poll_mountable_trampoline<
P: FnOnce(Result<(), glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let _ = ffi::g_file_poll_mountable_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = poll_mountable_trampoline::<P>;
unsafe {
ffi::g_file_poll_mountable(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn poll_mountable_future(
&self,
) -> Pin<Box_<dyn std::future::Future<Output = Result<(), glib::Error>> + 'static>> {
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.poll_mountable(Some(cancellable), move |res| {
send.resolve(res);
});
},
))
}
/// Returns the #GAppInfo that is registered as the default
/// application to handle the file specified by @self.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
/// ## `cancellable`
/// optional #GCancellable object, [`None`] to ignore
///
/// # Returns
///
/// a #GAppInfo if the handle was found,
/// [`None`] if there were errors.
/// When you are done with it, release it with g_object_unref()
#[doc(alias = "g_file_query_default_handler")]
fn query_default_handler(
&self,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<AppInfo, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_query_default_handler(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Async version of g_file_query_default_handler().
/// ## `io_priority`
/// the [I/O priority](iface.AsyncResult.html#io-priority) of the request
/// ## `cancellable`
/// optional #GCancellable object, [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback to call when the request is done
#[cfg(feature = "v2_60")]
#[cfg_attr(docsrs, doc(cfg(feature = "v2_60")))]
#[doc(alias = "g_file_query_default_handler_async")]
fn query_default_handler_async<P: FnOnce(Result<AppInfo, glib::Error>) + 'static>(
&self,
io_priority: glib::Priority,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn query_default_handler_async_trampoline<
P: FnOnce(Result<AppInfo, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let ret =
ffi::g_file_query_default_handler_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = query_default_handler_async_trampoline::<P>;
unsafe {
ffi::g_file_query_default_handler_async(
self.as_ref().to_glib_none().0,
io_priority.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
#[cfg(feature = "v2_60")]
#[cfg_attr(docsrs, doc(cfg(feature = "v2_60")))]
fn query_default_handler_future(
&self,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<AppInfo, glib::Error>> + 'static>> {
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.query_default_handler_async(io_priority, Some(cancellable), move |res| {
send.resolve(res);
});
},
))
}
/// Utility function to check if a particular file exists.
///
/// The fallback implementation of this API is using [`query_info()`][Self::query_info()]
/// and therefore may do blocking I/O. To asynchronously query the existence
/// of a file, use [`query_info_async()`][Self::query_info_async()].
///
/// Note that in many cases it is [racy to first check for file existence](https://en.wikipedia.org/wiki/Time_of_check_to_time_of_use)
/// and then execute something based on the outcome of that, because the
/// file might have been created or removed in between the operations. The
/// general approach to handling that is to not check, but just do the
/// operation and handle the errors as they come.
///
/// As an example of race-free checking, take the case of reading a file,
/// and if it doesn't exist, creating it. There are two racy versions: read
/// it, and on error create it; and: check if it exists, if not create it.
/// These can both result in two processes creating the file (with perhaps
/// a partially written file as the result). The correct approach is to
/// always try to create the file with g_file_create() which will either
/// atomically create the file or fail with a [`IOErrorEnum::Exists`][crate::IOErrorEnum::Exists] error.
///
/// However, in many cases an existence check is useful in a user interface,
/// for instance to make a menu item sensitive/insensitive, so that you don't
/// have to fool users that something is possible and then just show an error
/// dialog. If you do this, you should make sure to also handle the errors
/// that can happen due to races when you execute the operation.
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// [`true`] if the file exists (and can be detected without error),
/// [`false`] otherwise (or if cancelled).
#[doc(alias = "g_file_query_exists")]
fn query_exists(&self, cancellable: Option<&impl IsA<Cancellable>>) -> bool {
unsafe {
from_glib(ffi::g_file_query_exists(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
))
}
}
/// Utility function to inspect the #GFileType of a file. This is
/// implemented using g_file_query_info() and as such does blocking I/O.
///
/// The primary use case of this method is to check if a file is
/// a regular file, directory, or symlink.
/// ## `flags`
/// a set of #GFileQueryInfoFlags passed to g_file_query_info()
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// The #GFileType of the file and [`FileType::Unknown`][crate::FileType::Unknown]
/// if the file does not exist
#[doc(alias = "g_file_query_file_type")]
fn query_file_type(
&self,
flags: FileQueryInfoFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> FileType {
unsafe {
from_glib(ffi::g_file_query_file_type(
self.as_ref().to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
))
}
}
/// Similar to g_file_query_info(), but obtains information
/// about the filesystem the @self is on, rather than the file itself.
/// For instance the amount of space available and the type of
/// the filesystem.
///
/// The @attributes value is a string that specifies the attributes
/// that should be gathered. It is not an error if it's not possible
/// to read a particular requested attribute from a file - it just
/// won't be set. @attributes should be a comma-separated list of
/// attributes or attribute wildcards. The wildcard "*" means all
/// attributes, and a wildcard like "filesystem::*" means all attributes
/// in the filesystem namespace. The standard namespace for filesystem
/// attributes is "filesystem". Common attributes of interest are
/// [`FILE_ATTRIBUTE_FILESYSTEM_SIZE`][crate::FILE_ATTRIBUTE_FILESYSTEM_SIZE] (the total size of the filesystem
/// in bytes), [`FILE_ATTRIBUTE_FILESYSTEM_FREE`][crate::FILE_ATTRIBUTE_FILESYSTEM_FREE] (number of bytes available),
/// and [`FILE_ATTRIBUTE_FILESYSTEM_TYPE`][crate::FILE_ATTRIBUTE_FILESYSTEM_TYPE] (type of the filesystem).
///
/// If @cancellable is not [`None`], then the operation can be cancelled
/// by triggering the cancellable object from another thread. If the
/// operation was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be
/// returned.
///
/// If the file does not exist, the [`IOErrorEnum::NotFound`][crate::IOErrorEnum::NotFound] error will
/// be returned. Other errors are possible too, and depend on what
/// kind of filesystem the file is on.
/// ## `attributes`
/// an attribute query string
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// a #GFileInfo or [`None`] if there was an error.
/// Free the returned object with g_object_unref().
#[doc(alias = "g_file_query_filesystem_info")]
fn query_filesystem_info(
&self,
attributes: &str,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<FileInfo, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_query_filesystem_info(
self.as_ref().to_glib_none().0,
attributes.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Asynchronously gets the requested information about the filesystem
/// that the specified @self is on. The result is a #GFileInfo object
/// that contains key-value attributes (such as type or size for the
/// file).
///
/// For more details, see g_file_query_filesystem_info() which is the
/// synchronous version of this call.
///
/// When the operation is finished, @callback will be called. You can
/// then call g_file_query_info_finish() to get the result of the
/// operation.
/// ## `attributes`
/// an attribute query string
/// ## `io_priority`
/// the [I/O priority](iface.AsyncResult.html#io-priority) of the request
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback
/// to call when the request is satisfied
#[doc(alias = "g_file_query_filesystem_info_async")]
fn query_filesystem_info_async<P: FnOnce(Result<FileInfo, glib::Error>) + 'static>(
&self,
attributes: &str,
io_priority: glib::Priority,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn query_filesystem_info_async_trampoline<
P: FnOnce(Result<FileInfo, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let ret =
ffi::g_file_query_filesystem_info_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = query_filesystem_info_async_trampoline::<P>;
unsafe {
ffi::g_file_query_filesystem_info_async(
self.as_ref().to_glib_none().0,
attributes.to_glib_none().0,
io_priority.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn query_filesystem_info_future(
&self,
attributes: &str,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<FileInfo, glib::Error>> + 'static>> {
let attributes = String::from(attributes);
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.query_filesystem_info_async(
&attributes,
io_priority,
Some(cancellable),
move |res| {
send.resolve(res);
},
);
},
))
}
/// Gets the requested information about specified @self.
/// The result is a #GFileInfo object that contains key-value
/// attributes (such as the type or size of the file).
///
/// The @attributes value is a string that specifies the file
/// attributes that should be gathered. It is not an error if
/// it's not possible to read a particular requested attribute
/// from a file - it just won't be set. @attributes should be a
/// comma-separated list of attributes or attribute wildcards.
/// The wildcard "*" means all attributes, and a wildcard like
/// "standard::*" means all attributes in the standard namespace.
/// An example attribute query be "standard::*,owner::user".
/// The standard attributes are available as defines, like
/// [`FILE_ATTRIBUTE_STANDARD_NAME`][crate::FILE_ATTRIBUTE_STANDARD_NAME].
///
/// If @cancellable is not [`None`], then the operation can be cancelled
/// by triggering the cancellable object from another thread. If the
/// operation was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be
/// returned.
///
/// For symlinks, normally the information about the target of the
/// symlink is returned, rather than information about the symlink
/// itself. However if you pass [`FileQueryInfoFlags::NOFOLLOW_SYMLINKS`][crate::FileQueryInfoFlags::NOFOLLOW_SYMLINKS]
/// in @flags the information about the symlink itself will be returned.
/// Also, for symlinks that point to non-existing files the information
/// about the symlink itself will be returned.
///
/// If the file does not exist, the [`IOErrorEnum::NotFound`][crate::IOErrorEnum::NotFound] error will be
/// returned. Other errors are possible too, and depend on what kind of
/// filesystem the file is on.
/// ## `attributes`
/// an attribute query string
/// ## `flags`
/// a set of #GFileQueryInfoFlags
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// a #GFileInfo for the given @self, or [`None`]
/// on error. Free the returned object with g_object_unref().
#[doc(alias = "g_file_query_info")]
fn query_info(
&self,
attributes: &str,
flags: FileQueryInfoFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<FileInfo, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_query_info(
self.as_ref().to_glib_none().0,
attributes.to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Asynchronously gets the requested information about specified @self.
/// The result is a #GFileInfo object that contains key-value attributes
/// (such as type or size for the file).
///
/// For more details, see g_file_query_info() which is the synchronous
/// version of this call.
///
/// When the operation is finished, @callback will be called. You can
/// then call g_file_query_info_finish() to get the result of the operation.
/// ## `attributes`
/// an attribute query string
/// ## `flags`
/// a set of #GFileQueryInfoFlags
/// ## `io_priority`
/// the [I/O priority](iface.AsyncResult.html#io-priority) of the request
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback
/// to call when the request is satisfied
#[doc(alias = "g_file_query_info_async")]
fn query_info_async<P: FnOnce(Result<FileInfo, glib::Error>) + 'static>(
&self,
attributes: &str,
flags: FileQueryInfoFlags,
io_priority: glib::Priority,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn query_info_async_trampoline<
P: FnOnce(Result<FileInfo, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_query_info_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = query_info_async_trampoline::<P>;
unsafe {
ffi::g_file_query_info_async(
self.as_ref().to_glib_none().0,
attributes.to_glib_none().0,
flags.into_glib(),
io_priority.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn query_info_future(
&self,
attributes: &str,
flags: FileQueryInfoFlags,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<FileInfo, glib::Error>> + 'static>> {
let attributes = String::from(attributes);
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.query_info_async(
&attributes,
flags,
io_priority,
Some(cancellable),
move |res| {
send.resolve(res);
},
);
},
))
}
/// Obtain the list of settable attributes for the file.
///
/// Returns the type and full attribute name of all the attributes
/// that can be set on this file. This doesn't mean setting it will
/// always succeed though, you might get an access failure, or some
/// specific file may not support a specific attribute.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// a #GFileAttributeInfoList describing the settable attributes.
/// When you are done with it, release it with
/// g_file_attribute_info_list_unref()
#[doc(alias = "g_file_query_settable_attributes")]
fn query_settable_attributes(
&self,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<FileAttributeInfoList, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_query_settable_attributes(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Obtain the list of attribute namespaces where new attributes
/// can be created by a user. An example of this is extended
/// attributes (in the "xattr" namespace).
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// a #GFileAttributeInfoList describing the writable namespaces.
/// When you are done with it, release it with
/// g_file_attribute_info_list_unref()
#[doc(alias = "g_file_query_writable_namespaces")]
fn query_writable_namespaces(
&self,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<FileAttributeInfoList, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_query_writable_namespaces(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Opens a file for reading. The result is a #GFileInputStream that
/// can be used to read the contents of the file.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
///
/// If the file does not exist, the [`IOErrorEnum::NotFound`][crate::IOErrorEnum::NotFound] error will be
/// returned. If the file is a directory, the [`IOErrorEnum::IsDirectory`][crate::IOErrorEnum::IsDirectory]
/// error will be returned. Other errors are possible too, and depend
/// on what kind of filesystem the file is on.
/// ## `cancellable`
/// a #GCancellable
///
/// # Returns
///
/// #GFileInputStream or [`None`] on error.
/// Free the returned object with g_object_unref().
#[doc(alias = "g_file_read")]
fn read(
&self,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<FileInputStream, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_read(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Asynchronously opens @self for reading.
///
/// For more details, see g_file_read() which is
/// the synchronous version of this call.
///
/// When the operation is finished, @callback will be called.
/// You can then call g_file_read_finish() to get the result
/// of the operation.
/// ## `io_priority`
/// the [I/O priority](iface.AsyncResult.html#io-priority) of the request
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback
/// to call when the request is satisfied
#[doc(alias = "g_file_read_async")]
fn read_async<P: FnOnce(Result<FileInputStream, glib::Error>) + 'static>(
&self,
io_priority: glib::Priority,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn read_async_trampoline<
P: FnOnce(Result<FileInputStream, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_read_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = read_async_trampoline::<P>;
unsafe {
ffi::g_file_read_async(
self.as_ref().to_glib_none().0,
io_priority.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn read_future(
&self,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<FileInputStream, glib::Error>> + 'static>>
{
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.read_async(io_priority, Some(cancellable), move |res| {
send.resolve(res);
});
},
))
}
/// Returns an output stream for overwriting the file, possibly
/// creating a backup copy of the file first. If the file doesn't exist,
/// it will be created.
///
/// This will try to replace the file in the safest way possible so
/// that any errors during the writing will not affect an already
/// existing copy of the file. For instance, for local files it
/// may write to a temporary file and then atomically rename over
/// the destination when the stream is closed.
///
/// By default files created are generally readable by everyone,
/// but if you pass [`FileCreateFlags::PRIVATE`][crate::FileCreateFlags::PRIVATE] in @flags the file
/// will be made readable only to the current user, to the level that
/// is supported on the target filesystem.
///
/// If @cancellable is not [`None`], then the operation can be cancelled
/// by triggering the cancellable object from another thread. If the
/// operation was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be
/// returned.
///
/// If you pass in a non-[`None`] @etag value and @self already exists, then
/// this value is compared to the current entity tag of the file, and if
/// they differ an [`IOErrorEnum::WrongEtag`][crate::IOErrorEnum::WrongEtag] error is returned. This
/// generally means that the file has been changed since you last read
/// it. You can get the new etag from g_file_output_stream_get_etag()
/// after you've finished writing and closed the #GFileOutputStream. When
/// you load a new file you can use g_file_input_stream_query_info() to
/// get the etag of the file.
///
/// If @make_backup is [`true`], this function will attempt to make a
/// backup of the current file before overwriting it. If this fails
/// a [`IOErrorEnum::CantCreateBackup`][crate::IOErrorEnum::CantCreateBackup] error will be returned. If you
/// want to replace anyway, try again with @make_backup set to [`false`].
///
/// If the file is a directory the [`IOErrorEnum::IsDirectory`][crate::IOErrorEnum::IsDirectory] error will
/// be returned, and if the file is some other form of non-regular file
/// then a [`IOErrorEnum::NotRegularFile`][crate::IOErrorEnum::NotRegularFile] error will be returned. Some
/// file systems don't allow all file names, and may return an
/// [`IOErrorEnum::InvalidFilename`][crate::IOErrorEnum::InvalidFilename] error, and if the name is to long
/// [`IOErrorEnum::FilenameTooLong`][crate::IOErrorEnum::FilenameTooLong] will be returned. Other errors are
/// possible too, and depend on what kind of filesystem the file is on.
/// ## `etag`
/// an optional [entity tag](#entity-tags)
/// for the current #GFile, or #NULL to ignore
/// ## `make_backup`
/// [`true`] if a backup should be created
/// ## `flags`
/// a set of #GFileCreateFlags
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// a #GFileOutputStream or [`None`] on error.
/// Free the returned object with g_object_unref().
#[doc(alias = "g_file_replace")]
fn replace(
&self,
etag: Option<&str>,
make_backup: bool,
flags: FileCreateFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<FileOutputStream, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_replace(
self.as_ref().to_glib_none().0,
etag.to_glib_none().0,
make_backup.into_glib(),
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Asynchronously overwrites the file, replacing the contents,
/// possibly creating a backup copy of the file first.
///
/// For more details, see g_file_replace() which is
/// the synchronous version of this call.
///
/// When the operation is finished, @callback will be called.
/// You can then call g_file_replace_finish() to get the result
/// of the operation.
/// ## `etag`
/// an [entity tag](#entity-tags) for the current #GFile,
/// or [`None`] to ignore
/// ## `make_backup`
/// [`true`] if a backup should be created
/// ## `flags`
/// a set of #GFileCreateFlags
/// ## `io_priority`
/// the [I/O priority](iface.AsyncResult.html#io-priority) of the request
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback
/// to call when the request is satisfied
#[doc(alias = "g_file_replace_async")]
fn replace_async<P: FnOnce(Result<FileOutputStream, glib::Error>) + 'static>(
&self,
etag: Option<&str>,
make_backup: bool,
flags: FileCreateFlags,
io_priority: glib::Priority,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn replace_async_trampoline<
P: FnOnce(Result<FileOutputStream, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_replace_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = replace_async_trampoline::<P>;
unsafe {
ffi::g_file_replace_async(
self.as_ref().to_glib_none().0,
etag.to_glib_none().0,
make_backup.into_glib(),
flags.into_glib(),
io_priority.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn replace_future(
&self,
etag: Option<&str>,
make_backup: bool,
flags: FileCreateFlags,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<FileOutputStream, glib::Error>> + 'static>>
{
let etag = etag.map(ToOwned::to_owned);
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.replace_async(
etag.as_ref().map(::std::borrow::Borrow::borrow),
make_backup,
flags,
io_priority,
Some(cancellable),
move |res| {
send.resolve(res);
},
);
},
))
}
/// Replaces the contents of @self with @contents of @length bytes.
///
/// If @etag is specified (not [`None`]), any existing file must have that etag,
/// or the error [`IOErrorEnum::WrongEtag`][crate::IOErrorEnum::WrongEtag] will be returned.
///
/// If @make_backup is [`true`], this function will attempt to make a backup
/// of @self. Internally, it uses g_file_replace(), so will try to replace the
/// file contents in the safest way possible. For example, atomic renames are
/// used when replacing local files’ contents.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
///
/// The returned @new_etag can be used to verify that the file hasn't
/// changed the next time it is saved over.
/// ## `contents`
/// a string containing the new contents for @self
/// ## `etag`
/// the old [entity-tag](#entity-tags) for the document,
/// or [`None`]
/// ## `make_backup`
/// [`true`] if a backup should be created
/// ## `flags`
/// a set of #GFileCreateFlags
/// ## `cancellable`
/// optional #GCancellable object, [`None`] to ignore
///
/// # Returns
///
/// [`true`] if successful. If an error has occurred, this function
/// will return [`false`] and set @error appropriately if present.
///
/// ## `new_etag`
/// a location to a new [entity tag](#entity-tags)
/// for the document. This should be freed with g_free() when no longer
/// needed, or [`None`]
#[doc(alias = "g_file_replace_contents")]
fn replace_contents(
&self,
contents: &[u8],
etag: Option<&str>,
make_backup: bool,
flags: FileCreateFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<Option<glib::GString>, glib::Error> {
let length = contents.len() as _;
unsafe {
let mut new_etag = std::ptr::null_mut();
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_file_replace_contents(
self.as_ref().to_glib_none().0,
contents.to_glib_none().0,
length,
etag.to_glib_none().0,
make_backup.into_glib(),
flags.into_glib(),
&mut new_etag,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(from_glib_full(new_etag))
} else {
Err(from_glib_full(error))
}
}
}
//#[doc(alias = "g_file_replace_contents_bytes_async")]
//fn replace_contents_bytes_async<P: FnOnce(Result<(), glib::Error>) + 'static>(&self, contents: &glib::Bytes, etag: Option<&str>, make_backup: bool, flags: FileCreateFlags, cancellable: Option<&impl IsA<Cancellable>>, callback: P) {
// unsafe { TODO: call ffi:g_file_replace_contents_bytes_async() }
//}
/// Returns an output stream for overwriting the file in readwrite mode,
/// possibly creating a backup copy of the file first. If the file doesn't
/// exist, it will be created.
///
/// For details about the behaviour, see g_file_replace() which does the
/// same thing but returns an output stream only.
///
/// Note that in many non-local file cases read and write streams are not
/// supported, so make sure you really need to do read and write streaming,
/// rather than just opening for reading or writing.
/// ## `etag`
/// an optional [entity tag](#entity-tags)
/// for the current #GFile, or #NULL to ignore
/// ## `make_backup`
/// [`true`] if a backup should be created
/// ## `flags`
/// a set of #GFileCreateFlags
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// a #GFileIOStream or [`None`] on error.
/// Free the returned object with g_object_unref().
#[doc(alias = "g_file_replace_readwrite")]
fn replace_readwrite(
&self,
etag: Option<&str>,
make_backup: bool,
flags: FileCreateFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<FileIOStream, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_replace_readwrite(
self.as_ref().to_glib_none().0,
etag.to_glib_none().0,
make_backup.into_glib(),
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Asynchronously overwrites the file in read-write mode,
/// replacing the contents, possibly creating a backup copy
/// of the file first.
///
/// For more details, see g_file_replace_readwrite() which is
/// the synchronous version of this call.
///
/// When the operation is finished, @callback will be called.
/// You can then call g_file_replace_readwrite_finish() to get
/// the result of the operation.
/// ## `etag`
/// an [entity tag](#entity-tags) for the current #GFile,
/// or [`None`] to ignore
/// ## `make_backup`
/// [`true`] if a backup should be created
/// ## `flags`
/// a set of #GFileCreateFlags
/// ## `io_priority`
/// the [I/O priority](iface.AsyncResult.html#io-priority) of the request
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback
/// to call when the request is satisfied
#[doc(alias = "g_file_replace_readwrite_async")]
fn replace_readwrite_async<P: FnOnce(Result<FileIOStream, glib::Error>) + 'static>(
&self,
etag: Option<&str>,
make_backup: bool,
flags: FileCreateFlags,
io_priority: glib::Priority,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn replace_readwrite_async_trampoline<
P: FnOnce(Result<FileIOStream, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let ret =
ffi::g_file_replace_readwrite_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = replace_readwrite_async_trampoline::<P>;
unsafe {
ffi::g_file_replace_readwrite_async(
self.as_ref().to_glib_none().0,
etag.to_glib_none().0,
make_backup.into_glib(),
flags.into_glib(),
io_priority.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn replace_readwrite_future(
&self,
etag: Option<&str>,
make_backup: bool,
flags: FileCreateFlags,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<FileIOStream, glib::Error>> + 'static>>
{
let etag = etag.map(ToOwned::to_owned);
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.replace_readwrite_async(
etag.as_ref().map(::std::borrow::Borrow::borrow),
make_backup,
flags,
io_priority,
Some(cancellable),
move |res| {
send.resolve(res);
},
);
},
))
}
/// Resolves a relative path for @self to an absolute path.
///
/// This call does no blocking I/O.
///
/// If the @relative_path is an absolute path name, the resolution
/// is done absolutely (without taking @self path as base).
/// ## `relative_path`
/// a given relative path string
///
/// # Returns
///
/// a #GFile for the resolved path.
#[doc(alias = "g_file_resolve_relative_path")]
#[must_use]
fn resolve_relative_path(&self, relative_path: impl AsRef<std::path::Path>) -> File {
unsafe {
from_glib_full(ffi::g_file_resolve_relative_path(
self.as_ref().to_glib_none().0,
relative_path.as_ref().to_glib_none().0,
))
}
}
//#[doc(alias = "g_file_set_attribute")]
//fn set_attribute(&self, attribute: &str, type_: FileAttributeType, value_p: /*Unimplemented*/Option<Basic: Pointer>, flags: FileQueryInfoFlags, cancellable: Option<&impl IsA<Cancellable>>) -> Result<(), glib::Error> {
// unsafe { TODO: call ffi:g_file_set_attribute() }
//}
/// Sets @attribute of type [`FileAttributeType::ByteString`][crate::FileAttributeType::ByteString] to @value.
/// If @attribute is of a different type, this operation will fail,
/// returning [`false`].
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
/// ## `attribute`
/// a string containing the attribute's name
/// ## `value`
/// a string containing the attribute's new value
/// ## `flags`
/// a #GFileQueryInfoFlags
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// [`true`] if the @attribute was successfully set to @value
/// in the @self, [`false`] otherwise.
#[doc(alias = "g_file_set_attribute_byte_string")]
fn set_attribute_byte_string(
&self,
attribute: &str,
value: &str,
flags: FileQueryInfoFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_file_set_attribute_byte_string(
self.as_ref().to_glib_none().0,
attribute.to_glib_none().0,
value.to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Sets @attribute of type [`FileAttributeType::Int32`][crate::FileAttributeType::Int32] to @value.
/// If @attribute is of a different type, this operation will fail.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
/// ## `attribute`
/// a string containing the attribute's name
/// ## `value`
/// a #gint32 containing the attribute's new value
/// ## `flags`
/// a #GFileQueryInfoFlags
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// [`true`] if the @attribute was successfully set to @value
/// in the @self, [`false`] otherwise.
#[doc(alias = "g_file_set_attribute_int32")]
fn set_attribute_int32(
&self,
attribute: &str,
value: i32,
flags: FileQueryInfoFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_file_set_attribute_int32(
self.as_ref().to_glib_none().0,
attribute.to_glib_none().0,
value,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Sets @attribute of type [`FileAttributeType::Int64`][crate::FileAttributeType::Int64] to @value.
/// If @attribute is of a different type, this operation will fail.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
/// ## `attribute`
/// a string containing the attribute's name
/// ## `value`
/// a #guint64 containing the attribute's new value
/// ## `flags`
/// a #GFileQueryInfoFlags
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// [`true`] if the @attribute was successfully set, [`false`] otherwise.
#[doc(alias = "g_file_set_attribute_int64")]
fn set_attribute_int64(
&self,
attribute: &str,
value: i64,
flags: FileQueryInfoFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_file_set_attribute_int64(
self.as_ref().to_glib_none().0,
attribute.to_glib_none().0,
value,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Sets @attribute of type [`FileAttributeType::String`][crate::FileAttributeType::String] to @value.
/// If @attribute is of a different type, this operation will fail.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
/// ## `attribute`
/// a string containing the attribute's name
/// ## `value`
/// a string containing the attribute's value
/// ## `flags`
/// #GFileQueryInfoFlags
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// [`true`] if the @attribute was successfully set, [`false`] otherwise.
#[doc(alias = "g_file_set_attribute_string")]
fn set_attribute_string(
&self,
attribute: &str,
value: &str,
flags: FileQueryInfoFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_file_set_attribute_string(
self.as_ref().to_glib_none().0,
attribute.to_glib_none().0,
value.to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Sets @attribute of type [`FileAttributeType::Uint32`][crate::FileAttributeType::Uint32] to @value.
/// If @attribute is of a different type, this operation will fail.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
/// ## `attribute`
/// a string containing the attribute's name
/// ## `value`
/// a #guint32 containing the attribute's new value
/// ## `flags`
/// a #GFileQueryInfoFlags
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// [`true`] if the @attribute was successfully set to @value
/// in the @self, [`false`] otherwise.
#[doc(alias = "g_file_set_attribute_uint32")]
fn set_attribute_uint32(
&self,
attribute: &str,
value: u32,
flags: FileQueryInfoFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_file_set_attribute_uint32(
self.as_ref().to_glib_none().0,
attribute.to_glib_none().0,
value,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Sets @attribute of type [`FileAttributeType::Uint64`][crate::FileAttributeType::Uint64] to @value.
/// If @attribute is of a different type, this operation will fail.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
/// ## `attribute`
/// a string containing the attribute's name
/// ## `value`
/// a #guint64 containing the attribute's new value
/// ## `flags`
/// a #GFileQueryInfoFlags
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// [`true`] if the @attribute was successfully set to @value
/// in the @self, [`false`] otherwise.
#[doc(alias = "g_file_set_attribute_uint64")]
fn set_attribute_uint64(
&self,
attribute: &str,
value: u64,
flags: FileQueryInfoFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_file_set_attribute_uint64(
self.as_ref().to_glib_none().0,
attribute.to_glib_none().0,
value,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Asynchronously sets the attributes of @self with @info.
///
/// For more details, see g_file_set_attributes_from_info(),
/// which is the synchronous version of this call.
///
/// When the operation is finished, @callback will be called.
/// You can then call g_file_set_attributes_finish() to get
/// the result of the operation.
/// ## `info`
/// a #GFileInfo
/// ## `flags`
/// a #GFileQueryInfoFlags
/// ## `io_priority`
/// the [I/O priority](iface.AsyncResult.html#io-priority) of the request
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback
/// to call when the request is satisfied
#[doc(alias = "g_file_set_attributes_async")]
fn set_attributes_async<P: FnOnce(Result<FileInfo, glib::Error>) + 'static>(
&self,
info: &FileInfo,
flags: FileQueryInfoFlags,
io_priority: glib::Priority,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn set_attributes_async_trampoline<
P: FnOnce(Result<FileInfo, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let mut info = std::ptr::null_mut();
let _ = ffi::g_file_set_attributes_finish(
_source_object as *mut _,
res,
&mut info,
&mut error,
);
let result = if error.is_null() {
Ok(from_glib_full(info))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = set_attributes_async_trampoline::<P>;
unsafe {
ffi::g_file_set_attributes_async(
self.as_ref().to_glib_none().0,
info.to_glib_none().0,
flags.into_glib(),
io_priority.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn set_attributes_future(
&self,
info: &FileInfo,
flags: FileQueryInfoFlags,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<FileInfo, glib::Error>> + 'static>> {
let info = info.clone();
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.set_attributes_async(
&info,
flags,
io_priority,
Some(cancellable),
move |res| {
send.resolve(res);
},
);
},
))
}
/// Tries to set all attributes in the #GFileInfo on the target
/// values, not stopping on the first error.
///
/// If there is any error during this operation then @error will
/// be set to the first error. Error on particular fields are flagged
/// by setting the "status" field in the attribute value to
/// [`FileAttributeStatus::ErrorSetting`][crate::FileAttributeStatus::ErrorSetting], which means you can
/// also detect further errors.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
/// ## `info`
/// a #GFileInfo
/// ## `flags`
/// #GFileQueryInfoFlags
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// [`false`] if there was any error, [`true`] otherwise.
#[doc(alias = "g_file_set_attributes_from_info")]
fn set_attributes_from_info(
&self,
info: &FileInfo,
flags: FileQueryInfoFlags,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_file_set_attributes_from_info(
self.as_ref().to_glib_none().0,
info.to_glib_none().0,
flags.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Renames @self to the specified display name.
///
/// The display name is converted from UTF-8 to the correct encoding
/// for the target filesystem if possible and the @self is renamed to this.
///
/// If you want to implement a rename operation in the user interface the
/// edit name ([`FILE_ATTRIBUTE_STANDARD_EDIT_NAME`][crate::FILE_ATTRIBUTE_STANDARD_EDIT_NAME]) should be used as the
/// initial value in the rename widget, and then the result after editing
/// should be passed to g_file_set_display_name().
///
/// On success the resulting converted filename is returned.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
/// ## `display_name`
/// a string
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// a #GFile specifying what @self was renamed to,
/// or [`None`] if there was an error.
/// Free the returned object with g_object_unref().
#[doc(alias = "g_file_set_display_name")]
fn set_display_name(
&self,
display_name: &str,
cancellable: Option<&impl IsA<Cancellable>>,
) -> Result<File, glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let ret = ffi::g_file_set_display_name(
self.as_ref().to_glib_none().0,
display_name.to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
}
}
}
/// Asynchronously sets the display name for a given #GFile.
///
/// For more details, see g_file_set_display_name() which is
/// the synchronous version of this call.
///
/// When the operation is finished, @callback will be called.
/// You can then call g_file_set_display_name_finish() to get
/// the result of the operation.
/// ## `display_name`
/// a string
/// ## `io_priority`
/// the [I/O priority](iface.AsyncResult.html#io-priority) of the request
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback
/// to call when the request is satisfied
#[doc(alias = "g_file_set_display_name_async")]
fn set_display_name_async<P: FnOnce(Result<File, glib::Error>) + 'static>(
&self,
display_name: &str,
io_priority: glib::Priority,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn set_display_name_async_trampoline<
P: FnOnce(Result<File, glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let ret =
ffi::g_file_set_display_name_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(from_glib_full(ret))
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = set_display_name_async_trampoline::<P>;
unsafe {
ffi::g_file_set_display_name_async(
self.as_ref().to_glib_none().0,
display_name.to_glib_none().0,
io_priority.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn set_display_name_future(
&self,
display_name: &str,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<File, glib::Error>> + 'static>> {
let display_name = String::from(display_name);
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.set_display_name_async(
&display_name,
io_priority,
Some(cancellable),
move |res| {
send.resolve(res);
},
);
},
))
}
/// Starts a file of type [`FileType::Mountable`][crate::FileType::Mountable].
/// Using @start_operation, you can request callbacks when, for instance,
/// passwords are needed during authentication.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
///
/// When the operation is finished, @callback will be called.
/// You can then call g_file_mount_mountable_finish() to get
/// the result of the operation.
/// ## `flags`
/// flags affecting the operation
/// ## `start_operation`
/// a #GMountOperation, or [`None`] to avoid user interaction
/// ## `cancellable`
/// optional #GCancellable object, [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback to call when the request is satisfied, or [`None`]
#[doc(alias = "g_file_start_mountable")]
fn start_mountable<P: FnOnce(Result<(), glib::Error>) + 'static>(
&self,
flags: DriveStartFlags,
start_operation: Option<&impl IsA<MountOperation>>,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn start_mountable_trampoline<
P: FnOnce(Result<(), glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let _ = ffi::g_file_start_mountable_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = start_mountable_trampoline::<P>;
unsafe {
ffi::g_file_start_mountable(
self.as_ref().to_glib_none().0,
flags.into_glib(),
start_operation.map(|p| p.as_ref()).to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn start_mountable_future(
&self,
flags: DriveStartFlags,
start_operation: Option<&(impl IsA<MountOperation> + Clone + 'static)>,
) -> Pin<Box_<dyn std::future::Future<Output = Result<(), glib::Error>> + 'static>> {
let start_operation = start_operation.map(ToOwned::to_owned);
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.start_mountable(
flags,
start_operation.as_ref().map(::std::borrow::Borrow::borrow),
Some(cancellable),
move |res| {
send.resolve(res);
},
);
},
))
}
/// Stops a file of type [`FileType::Mountable`][crate::FileType::Mountable].
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
///
/// When the operation is finished, @callback will be called.
/// You can then call g_file_stop_mountable_finish() to get
/// the result of the operation.
/// ## `flags`
/// flags affecting the operation
/// ## `mount_operation`
/// a #GMountOperation,
/// or [`None`] to avoid user interaction.
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback to call
/// when the request is satisfied, or [`None`]
#[doc(alias = "g_file_stop_mountable")]
fn stop_mountable<P: FnOnce(Result<(), glib::Error>) + 'static>(
&self,
flags: MountUnmountFlags,
mount_operation: Option<&impl IsA<MountOperation>>,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn stop_mountable_trampoline<
P: FnOnce(Result<(), glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let _ = ffi::g_file_stop_mountable_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = stop_mountable_trampoline::<P>;
unsafe {
ffi::g_file_stop_mountable(
self.as_ref().to_glib_none().0,
flags.into_glib(),
mount_operation.map(|p| p.as_ref()).to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn stop_mountable_future(
&self,
flags: MountUnmountFlags,
mount_operation: Option<&(impl IsA<MountOperation> + Clone + 'static)>,
) -> Pin<Box_<dyn std::future::Future<Output = Result<(), glib::Error>> + 'static>> {
let mount_operation = mount_operation.map(ToOwned::to_owned);
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.stop_mountable(
flags,
mount_operation.as_ref().map(::std::borrow::Borrow::borrow),
Some(cancellable),
move |res| {
send.resolve(res);
},
);
},
))
}
/// Checks if @self supports
/// [thread-default contexts][g-main-context-push-thread-default-context].
/// If this returns [`false`], you cannot perform asynchronous operations on
/// @self in a thread that has a thread-default context.
///
/// # Returns
///
/// Whether or not @self supports thread-default contexts.
#[doc(alias = "g_file_supports_thread_contexts")]
fn supports_thread_contexts(&self) -> bool {
unsafe {
from_glib(ffi::g_file_supports_thread_contexts(
self.as_ref().to_glib_none().0,
))
}
}
/// Sends @self to the "Trashcan", if possible. This is similar to
/// deleting it, but the user can recover it before emptying the trashcan.
/// Trashing is disabled for system mounts by default (see
/// g_unix_mount_entry_is_system_internal()), so this call can return the
/// [`IOErrorEnum::NotSupported`][crate::IOErrorEnum::NotSupported] error. Since GLib 2.66, the `x-gvfs-notrash` unix
/// mount option can be used to disable g_file_trash() support for particular
/// mounts, the [`IOErrorEnum::NotSupported`][crate::IOErrorEnum::NotSupported] error will be returned in that case.
/// Since 2.82, the `x-gvfs-trash` unix mount option can be used to enable
/// g_file_trash() support for particular system mounts.
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
///
/// # Returns
///
/// [`true`] on successful trash, [`false`] otherwise.
#[doc(alias = "g_file_trash")]
fn trash(&self, cancellable: Option<&impl IsA<Cancellable>>) -> Result<(), glib::Error> {
unsafe {
let mut error = std::ptr::null_mut();
let is_ok = ffi::g_file_trash(
self.as_ref().to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
&mut error,
);
debug_assert_eq!(is_ok == glib::ffi::GFALSE, !error.is_null());
if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
}
}
}
/// Asynchronously sends @self to the Trash location, if possible.
/// ## `io_priority`
/// the [I/O priority](iface.AsyncResult.html#io-priority) of the request
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback to call
/// when the request is satisfied
#[doc(alias = "g_file_trash_async")]
fn trash_async<P: FnOnce(Result<(), glib::Error>) + 'static>(
&self,
io_priority: glib::Priority,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn trash_async_trampoline<
P: FnOnce(Result<(), glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let _ = ffi::g_file_trash_finish(_source_object as *mut _, res, &mut error);
let result = if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = trash_async_trampoline::<P>;
unsafe {
ffi::g_file_trash_async(
self.as_ref().to_glib_none().0,
io_priority.into_glib(),
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn trash_future(
&self,
io_priority: glib::Priority,
) -> Pin<Box_<dyn std::future::Future<Output = Result<(), glib::Error>> + 'static>> {
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.trash_async(io_priority, Some(cancellable), move |res| {
send.resolve(res);
});
},
))
}
/// Unmounts a file of type [`FileType::Mountable`][crate::FileType::Mountable].
///
/// If @cancellable is not [`None`], then the operation can be cancelled by
/// triggering the cancellable object from another thread. If the operation
/// was cancelled, the error [`IOErrorEnum::Cancelled`][crate::IOErrorEnum::Cancelled] will be returned.
///
/// When the operation is finished, @callback will be called.
/// You can then call g_file_unmount_mountable_finish() to get
/// the result of the operation.
/// ## `flags`
/// flags affecting the operation
/// ## `mount_operation`
/// a #GMountOperation,
/// or [`None`] to avoid user interaction
/// ## `cancellable`
/// optional #GCancellable object,
/// [`None`] to ignore
/// ## `callback`
/// a #GAsyncReadyCallback
/// to call when the request is satisfied
#[doc(alias = "g_file_unmount_mountable_with_operation")]
fn unmount_mountable_with_operation<P: FnOnce(Result<(), glib::Error>) + 'static>(
&self,
flags: MountUnmountFlags,
mount_operation: Option<&impl IsA<MountOperation>>,
cancellable: Option<&impl IsA<Cancellable>>,
callback: P,
) {
let main_context = glib::MainContext::ref_thread_default();
let is_main_context_owner = main_context.is_owner();
let has_acquired_main_context = (!is_main_context_owner)
.then(|| main_context.acquire().ok())
.flatten();
assert!(
is_main_context_owner || has_acquired_main_context.is_some(),
"Async operations only allowed if the thread is owning the MainContext"
);
let user_data: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::new(glib::thread_guard::ThreadGuard::new(callback));
unsafe extern "C" fn unmount_mountable_with_operation_trampoline<
P: FnOnce(Result<(), glib::Error>) + 'static,
>(
_source_object: *mut glib::gobject_ffi::GObject,
res: *mut crate::ffi::GAsyncResult,
user_data: glib::ffi::gpointer,
) {
let mut error = std::ptr::null_mut();
let _ = ffi::g_file_unmount_mountable_with_operation_finish(
_source_object as *mut _,
res,
&mut error,
);
let result = if error.is_null() {
Ok(())
} else {
Err(from_glib_full(error))
};
let callback: Box_<glib::thread_guard::ThreadGuard<P>> =
Box_::from_raw(user_data as *mut _);
let callback: P = callback.into_inner();
callback(result);
}
let callback = unmount_mountable_with_operation_trampoline::<P>;
unsafe {
ffi::g_file_unmount_mountable_with_operation(
self.as_ref().to_glib_none().0,
flags.into_glib(),
mount_operation.map(|p| p.as_ref()).to_glib_none().0,
cancellable.map(|p| p.as_ref()).to_glib_none().0,
Some(callback),
Box_::into_raw(user_data) as *mut _,
);
}
}
fn unmount_mountable_with_operation_future(
&self,
flags: MountUnmountFlags,
mount_operation: Option<&(impl IsA<MountOperation> + Clone + 'static)>,
) -> Pin<Box_<dyn std::future::Future<Output = Result<(), glib::Error>> + 'static>> {
let mount_operation = mount_operation.map(ToOwned::to_owned);
Box_::pin(crate::GioFuture::new(
self,
move |obj, cancellable, send| {
obj.unmount_mountable_with_operation(
flags,
mount_operation.as_ref().map(::std::borrow::Borrow::borrow),
Some(cancellable),
move |res| {
send.resolve(res);
},
);
},
))
}
}
impl<O: IsA<File>> FileExt for O {}