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
//! Models relating to guilds and types that it owns.
pub mod audit_log;
pub mod automod;
mod emoji;
mod guild_id;
mod guild_preview;
mod integration;
mod member;
mod partial_guild;
mod premium_tier;
mod role;
mod scheduled_event;
mod system_channel;
mod welcome_screen;
#[cfg(feature = "model")]
use futures::stream::StreamExt;
use serde::de::Error as DeError;
#[cfg(feature = "model")]
use tracing::error;
#[cfg(all(feature = "model", feature = "cache"))]
use tracing::warn;
#[doc(hidden)]
#[deprecated(note = "import the types from the `audit_log` module")]
pub use self::audit_log::*;
pub use self::emoji::*;
pub use self::guild_id::*;
pub use self::guild_preview::*;
pub use self::integration::*;
pub use self::member::*;
pub use self::partial_guild::*;
pub use self::premium_tier::*;
pub use self::role::*;
pub use self::scheduled_event::*;
pub use self::system_channel::*;
pub use self::welcome_screen::*;
use super::utils::*;
#[cfg(feature = "model")]
use crate::builder::{
AddMember,
CreateApplicationCommand,
CreateApplicationCommandPermissionsData,
CreateApplicationCommands,
CreateApplicationCommandsPermissions,
CreateChannel,
CreateScheduledEvent,
CreateSticker,
EditAutoModRule,
EditGuild,
EditGuildWelcomeScreen,
EditGuildWidget,
EditMember,
EditRole,
EditScheduledEvent,
EditSticker,
};
#[cfg(all(feature = "cache", feature = "model"))]
use crate::cache::Cache;
#[cfg(feature = "collector")]
use crate::client::bridge::gateway::ShardMessenger;
#[cfg(feature = "collector")]
use crate::collector::{
CollectReaction,
CollectReply,
MessageCollectorBuilder,
ReactionCollectorBuilder,
};
#[cfg(feature = "model")]
use crate::constants::LARGE_THRESHOLD;
#[cfg(feature = "model")]
use crate::http::{CacheHttp, Http, UserPagination};
use crate::json::prelude::*;
use crate::json::{from_number, from_value};
#[cfg(feature = "model")]
use crate::model::application::command::{Command, CommandPermission};
#[cfg(feature = "model")]
use crate::model::guild::automod::Rule;
use crate::model::prelude::*;
use crate::model::utils::{emojis, presences, roles, stickers};
use crate::model::Timestamp;
/// A representation of a banning of a user.
#[derive(Clone, Debug, Deserialize, Eq, PartialEq, Hash, Serialize)]
pub struct Ban {
/// The reason given for this ban.
pub reason: Option<String>,
/// The user that was banned.
pub user: User,
}
/// Information about a Discord guild, such as channels, emojis, etc.
#[derive(Clone, Debug, Serialize)]
#[non_exhaustive]
pub struct Guild {
/// Id of a voice channel that's considered the AFK channel.
pub afk_channel_id: Option<ChannelId>,
/// The amount of seconds a user can not show any activity in a voice
/// channel before being moved to an AFK channel -- if one exists.
pub afk_timeout: u64,
/// Application ID of the guild creator if it is bot-created.
pub application_id: Option<ApplicationId>,
/// All voice and text channels contained within a guild.
///
/// This contains all channels regardless of permissions (i.e. the ability
/// of the bot to read from or connect to them).
#[serde(serialize_with = "serialize_map_values")]
pub channels: HashMap<ChannelId, Channel>,
/// Indicator of whether notifications for all messages are enabled by
/// default in the guild.
pub default_message_notifications: DefaultMessageNotificationLevel,
/// All of the guild's custom emojis.
#[serde(serialize_with = "serialize_map_values")]
pub emojis: HashMap<EmojiId, Emoji>,
/// Default explicit content filter level.
pub explicit_content_filter: ExplicitContentFilter,
/// The guild features. More information available at
/// [`discord documentation`].
///
/// The following is a list of known features:
///
/// - `ANIMATED_ICON`
/// - `BANNER`
/// - `COMMERCE`
/// - `COMMUNITY`
/// - `DISCOVERABLE`
/// - `FEATURABLE`
/// - `INVITE_SPLASH`
/// - `MEMBER_VERIFICATION_GATE_ENABLED`
/// - `MONETIZATION_ENABLED`
/// - `MORE_STICKERS`
/// - `NEWS`
/// - `PARTNERED`
/// - `PREVIEW_ENABLED`
/// - `PRIVATE_THREADS`
/// - `ROLE_ICONS`
/// - `SEVEN_DAY_THREAD_ARCHIVE`
/// - `THREE_DAY_THREAD_ARCHIVE`
/// - `TICKETED_EVENTS_ENABLED`
/// - `VANITY_URL`
/// - `VERIFIED`
/// - `VIP_REGIONS`
/// - `WELCOME_SCREEN_ENABLED`
/// - `THREE_DAY_THREAD_ARCHIVE`
/// - `SEVEN_DAY_THREAD_ARCHIVE`
/// - `PRIVATE_THREADS`
///
///
/// [`discord documentation`]: https://discord.com/developers/docs/resources/guild#guild-object-guild-features
pub features: Vec<String>,
/// The hash of the icon used by the guild.
///
/// In the client, this appears on the guild list on the left-hand side.
pub icon: Option<String>,
/// The unique Id identifying the guild.
///
/// This is equivalent to the Id of the default role (`@everyone`) and also
/// that of the default channel (typically `#general`).
pub id: GuildId,
/// The date that the current user joined the guild.
pub joined_at: Timestamp,
/// Indicator of whether the guild is considered "large" by Discord.
pub large: bool,
/// The number of members in the guild.
pub member_count: u64,
/// Users who are members of the guild.
///
/// Members might not all be available when the [`ReadyEvent`] is received
/// if the [`Self::member_count`] is greater than the [`LARGE_THRESHOLD`] set by
/// the library.
#[serde(serialize_with = "serialize_map_values")]
pub members: HashMap<UserId, Member>,
/// Indicator of whether the guild requires multi-factor authentication for
/// [`Role`]s or [`User`]s with moderation permissions.
pub mfa_level: MfaLevel,
/// The name of the guild.
pub name: String,
/// The Id of the [`User`] who owns the guild.
pub owner_id: UserId,
/// A mapping of [`User`]s' Ids to their current presences.
///
/// **Note**: This will be empty unless the "guild presences" privileged
/// intent is enabled.
#[serde(serialize_with = "serialize_map_values")]
pub presences: HashMap<UserId, Presence>,
/// A mapping of the guild's roles.
#[serde(serialize_with = "serialize_map_values")]
pub roles: HashMap<RoleId, Role>,
/// An identifying hash of the guild's splash icon.
///
/// If the `InviteSplash` feature is enabled, this can be used to generate
/// a URL to a splash image.
pub splash: Option<String>,
/// An identifying hash of the guild discovery's splash icon.
///
/// **Note**: Only present for guilds with the `DISCOVERABLE` feature.
pub discovery_splash: Option<String>,
/// The ID of the channel to which system messages are sent.
pub system_channel_id: Option<ChannelId>,
/// System channel flags.
pub system_channel_flags: SystemChannelFlags,
/// The id of the channel where rules and/or guidelines are displayed.
///
/// **Note**: Only available on `COMMUNITY` guild, see [`Self::features`].
pub rules_channel_id: Option<ChannelId>,
/// The id of the channel where admins and moderators of Community guilds
/// receive notices from Discord.
///
/// **Note**: Only available on `COMMUNITY` guild, see [`Self::features`].
pub public_updates_channel_id: Option<ChannelId>,
/// Indicator of the current verification level of the guild.
pub verification_level: VerificationLevel,
/// A mapping of [`User`]s to their current voice state.
#[serde(serialize_with = "serialize_map_values")]
pub voice_states: HashMap<UserId, VoiceState>,
/// The server's description, if it has one.
pub description: Option<String>,
/// The server's premium boosting level.
#[serde(default)]
pub premium_tier: PremiumTier,
/// The total number of users currently boosting this server.
#[serde(default)]
pub premium_subscription_count: u64,
/// The guild's banner, if it has one.
pub banner: Option<String>,
/// The vanity url code for the guild, if it has one.
pub vanity_url_code: Option<String>,
/// The preferred locale of this guild only set if guild has the "DISCOVERABLE"
/// feature, defaults to en-US.
pub preferred_locale: String,
/// The welcome screen of the guild.
///
/// **Note**: Only available on `COMMUNITY` guild, see [`Self::features`].
pub welcome_screen: Option<GuildWelcomeScreen>,
/// Approximate number of members in this guild.
pub approximate_member_count: Option<u64>,
/// Approximate number of non-offline members in this guild.
pub approximate_presence_count: Option<u64>,
/// The guild NSFW state. See [`discord support article`].
///
/// [`discord support article`]: https://support.discord.com/hc/en-us/articles/1500005389362-NSFW-Server-Designation
pub nsfw_level: NsfwLevel,
/// The maximum amount of users in a video channel.
pub max_video_channel_users: Option<u64>,
/// The maximum number of presences for the guild. The default value is currently 25000.
///
/// **Note**: It is in effect when it is `None`.
pub max_presences: Option<u64>,
/// The maximum number of members for the guild.
pub max_members: Option<u64>,
/// Whether or not the guild widget is enabled.
pub widget_enabled: Option<bool>,
/// The channel id that the widget will generate an invite to, or null if set to no invite
pub widget_channel_id: Option<ChannelId>,
/// The stage instances in this guild.
#[serde(default)]
pub stage_instances: Vec<StageInstance>,
/// All active threads in this guild that current user has permission to view.
#[serde(default)]
pub threads: Vec<GuildChannel>,
/// All of the guild's custom stickers.
#[serde(serialize_with = "serialize_map_values")]
pub stickers: HashMap<StickerId, Sticker>,
}
#[cfg(feature = "model")]
impl Guild {
/// Gets all auto moderation [`Rule`]s of this guild via HTTP.
///
/// **Note**: Requires the [Manage Guild] permission.
///
/// # Errors
///
/// Returns an [`Error::Http`] if the guild is unavailable.
///
/// [Manage Guild]: Permissions::MANAGE_GUILD
#[inline]
pub async fn automod_rules(self, http: impl AsRef<Http>) -> Result<Vec<Rule>> {
self.id.automod_rules(http).await
}
/// Gets an auto moderation [`Rule`] of this guild by its ID via HTTP.
///
/// **Note**: Requires the [Manage Guild] permission.
///
/// # Errors
///
/// Returns an [`Error::Http`] if a rule with the given ID does not exist.
///
/// [Manage Guild]: Permissions::MANAGE_GUILD
#[inline]
pub async fn automod_rule(
self,
http: impl AsRef<Http>,
rule_id: impl Into<RuleId>,
) -> Result<Rule> {
self.id.automod_rule(http, rule_id).await
}
/// Creates an auto moderation [`Rule`] in the guild.
///
/// **Note**: Requires the [Manage Guild] permission.
///
/// # Examples
///
/// Create a custom keyword filter to block the message and timeout the author.
///
/// ```ignore
/// use serenity::model::guild::automod::{Action, Trigger};
/// use serenity::model::id::GuildId;
///
/// let _rule = guild
/// .create_automod_rule(&http, |r| {
/// r.name("foobar filter")
/// .trigger(Trigger::Keyword(vec!["foo*".to_string(), "*bar".to_string()]))
/// .actions(vec![Action::BlockMessage, Action::Timeout(60)])
/// })
/// .await;
/// ```
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission,
/// or if invalid values are set.
///
/// [Manage Guild]: Permissions::MANAGE_GUILD
#[inline]
pub async fn create_automod_rule(
self,
http: impl AsRef<Http>,
f: impl FnOnce(&mut EditAutoModRule) -> &mut EditAutoModRule,
) -> Result<Rule> {
self.id.create_automod_rule(http, f).await
}
/// Edit an auto moderation [`Rule`] by its ID.
///
/// **Note**: Requires the [Manage Guild] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission,
/// or if invalid values are set.
///
/// [Manage Guild]: Permissions::MANAGE_GUILD
#[inline]
pub async fn edit_automod_rule(
self,
http: impl AsRef<Http>,
rule_id: impl Into<RuleId>,
f: impl FnOnce(&mut EditAutoModRule) -> &mut EditAutoModRule,
) -> Result<Rule> {
self.id.edit_automod_rule(http, rule_id, f).await
}
/// Deletes an auto moderation [`Rule`] from the guild.
///
/// **Note**: Requires the [Manage Guild] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission,
/// or if a rule with that Id does not exist.
///
/// [Manage Guild]: Permissions::MANAGE_GUILD
#[inline]
pub async fn delete_automod_rule(
self,
http: impl AsRef<Http>,
rule_id: impl Into<RuleId>,
) -> Result<()> {
self.id.delete_automod_rule(http, rule_id).await
}
#[cfg(feature = "cache")]
fn check_hierarchy(&self, cache: impl AsRef<Cache>, other_user: UserId) -> Result<()> {
let current_id = cache.as_ref().current_user().id;
if let Some(higher) = self.greater_member_hierarchy(&cache, other_user, current_id) {
if higher != current_id {
return Err(Error::Model(ModelError::Hierarchy));
}
}
Ok(())
}
/// Returns the "default" channel of the guild for the passed user id.
/// (This returns the first channel that can be read by the user, if there isn't one,
/// returns [`None`])
pub async fn default_channel(&self, uid: UserId) -> Option<&GuildChannel> {
let member = self.members.get(&uid)?;
for channel in self.channels.values() {
if let Channel::Guild(channel) = channel {
if self.user_permissions_in(channel, member).ok()?.view_channel() {
return Some(channel);
}
}
}
None
}
/// Returns the guaranteed "default" channel of the guild.
/// (This returns the first channel that can be read by everyone, if there isn't one,
/// returns [`None`])
///
/// **Note**: This is very costly if used in a server with lots of channels,
/// members, or both.
#[must_use]
pub fn default_channel_guaranteed(&self) -> Option<&GuildChannel> {
for channel in self.channels.values() {
if let Channel::Guild(channel) = channel {
for member in self.members.values() {
if self.user_permissions_in(channel, member).ok()?.view_channel() {
return Some(channel);
}
}
}
}
None
}
#[cfg(feature = "cache")]
async fn has_perms(&self, cache_http: impl CacheHttp, mut permissions: Permissions) -> bool {
if let Some(cache) = cache_http.cache() {
let user_id = cache.current_user().id;
if let Ok(perms) = self.member_permissions(&cache_http, user_id).await {
permissions.remove(perms);
permissions.is_empty()
} else {
false
}
} else {
false
}
}
#[cfg(feature = "cache")]
pub fn channel_id_from_name(
&self,
cache: impl AsRef<Cache>,
name: impl AsRef<str>,
) -> Option<ChannelId> {
let name = name.as_ref();
let guild_channels = cache.as_ref().guild_channels(&self.id)?;
for channel_entry in guild_channels.iter() {
let (id, channel) = channel_entry.pair();
if channel.name == name {
return Some(*id);
}
}
None
}
/// Ban a [`User`] from the guild, deleting a number of
/// days' worth of messages (`dmd`) between the range 0 and 7.
///
/// Refer to the documentation for [`Guild::ban`] for more information.
///
/// **Note**: Requires the [Ban Members] permission.
///
/// # Examples
///
/// Ban a member and remove all messages they've sent in the last 4 days:
///
/// ```rust,ignore
/// // assumes a `user` and `guild` have already been bound
/// let _ = guild.ban(user, 4);
/// ```
///
/// # Errors
///
/// Returns a [`ModelError::DeleteMessageDaysAmount`] if the number of
/// days' worth of messages to delete is over the maximum.
///
/// If the `cache` is enabled, returns a [`ModelError::InvalidPermissions`]
/// if the current user does not have permission to perform bans, or may
/// return a [`ModelError::Hierarchy`] if the member to be banned has a
/// higher role than the current user.
///
/// Otherwise returns [`Error::Http`] if the member cannot be banned.
///
/// [Ban Members]: Permissions::BAN_MEMBERS
#[inline]
pub async fn ban(
&self,
cache_http: impl CacheHttp,
user: impl Into<UserId>,
dmd: u8,
) -> Result<()> {
self._ban_with_reason(cache_http, user.into(), dmd, "").await
}
/// Ban a [`User`] from the guild with a reason. Refer to [`Self::ban`] to further documentation.
///
/// # Errors
///
/// In addition to the possible reasons [`Self::ban`] may return an error, an [`Error::ExceededLimit`]
/// may also be returned if the reason is too long.
#[inline]
pub async fn ban_with_reason(
&self,
cache_http: impl CacheHttp,
user: impl Into<UserId>,
dmd: u8,
reason: impl AsRef<str>,
) -> Result<()> {
self._ban_with_reason(cache_http, user.into(), dmd, reason.as_ref()).await
}
async fn _ban_with_reason(
&self,
cache_http: impl CacheHttp,
user: UserId,
dmd: u8,
reason: &str,
) -> Result<()> {
#[cfg(feature = "cache")]
{
if let Some(cache) = cache_http.cache() {
let req = Permissions::BAN_MEMBERS;
if !self.has_perms(&cache_http, req).await {
return Err(Error::Model(ModelError::InvalidPermissions(req)));
}
self.check_hierarchy(cache, user)?;
}
}
self.id.ban_with_reason(cache_http.http(), user, dmd, reason).await
}
/// Returns the formatted URL of the guild's banner image, if one exists.
#[must_use]
pub fn banner_url(&self) -> Option<String> {
self.banner.as_ref().map(|banner| cdn!("/banners/{}/{}.webp?size=1024", self.id, banner))
}
/// Retrieves a list of [`Ban`]s for the guild.
///
/// **Note**: Requires the [Ban Members] permission.
///
/// # Errors
///
/// If the `cache` is enabled, returns a [`ModelError::InvalidPermissions`]
/// if the current user does not have permission to perform bans.
///
/// [Ban Members]: Permissions::BAN_MEMBERS
pub async fn bans(&self, cache_http: impl CacheHttp) -> Result<Vec<Ban>> {
#[cfg(feature = "cache")]
{
if cache_http.cache().is_some() {
let req = Permissions::BAN_MEMBERS;
if !self.has_perms(&cache_http, req).await {
return Err(Error::Model(ModelError::InvalidPermissions(req)));
}
}
}
self.id.bans(cache_http.http()).await
}
/// Adds a [`User`] to this guild with a valid OAuth2 access token.
///
/// Returns the created [`Member`] object, or nothing if the user is already a member of the guild.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission,
/// or if invalid values are set.
#[inline]
pub async fn add_member(
&self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>,
f: impl FnOnce(&mut AddMember) -> &mut AddMember,
) -> Result<Option<Member>> {
self.id.add_member(http, user_id, f).await
}
/// Retrieves a list of [`AuditLogs`] for the guild.
///
/// **Note**: Requires the [View Audit Log] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user does not have permission
/// to view the audit log, or if an invalid value is given.
///
/// [View Audit Log]: Permissions::VIEW_AUDIT_LOG
#[inline]
pub async fn audit_logs(
&self,
http: impl AsRef<Http>,
action_type: Option<u8>,
user_id: Option<UserId>,
before: Option<AuditLogEntryId>,
limit: Option<u8>,
) -> Result<AuditLogs> {
self.id.audit_logs(&http, action_type, user_id, before, limit).await
}
/// Gets all of the guild's channels over the REST API.
///
/// # Errors
///
/// Returns [`Error::Http`] if the guild is currently unavailable.
#[inline]
pub async fn channels(
&self,
http: impl AsRef<Http>,
) -> Result<HashMap<ChannelId, GuildChannel>> {
self.id.channels(&http).await
}
/// Creates a guild with the data provided.
///
/// Only a [`PartialGuild`] will be immediately returned, and a full
/// [`Guild`] will be received over a [`Shard`].
///
/// **Note**: This endpoint is usually only available for user accounts.
/// Refer to Discord's information for the endpoint [here][whitelist] for
/// more information. If you require this as a bot, re-think what you are
/// doing and if it _really_ needs to be doing this.
///
/// # Examples
///
/// Create a guild called `"test"` in the [US West region] with no icon:
///
/// ```rust,ignore
/// use serenity::model::Guild;
///
/// let _guild = Guild::create_guild(&http, "test", None).await;
/// ```
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user cannot create a Guild.
///
/// [`Shard`]: crate::gateway::Shard
/// [whitelist]: https://discord.com/developers/docs/resources/guild#create-guild
pub async fn create(
http: impl AsRef<Http>,
name: &str,
icon: Option<&str>,
) -> Result<PartialGuild> {
let map = json!({
"icon": icon,
"name": name,
});
http.as_ref().create_guild(&map).await
}
/// Creates a new [`Channel`] in the guild.
///
/// **Note**: Requires the [Manage Channels] permission.
///
/// # Examples
///
/// ```rust,ignore
/// use serenity::model::ChannelType;
///
/// // assuming a `guild` has already been bound
///
/// let _ = guild
/// .create_channel(&http, |c| c.name("my-test-channel").kind(ChannelType::Text))
/// .await;
/// ```
///
/// # Errors
///
/// If the `cache` is enabled, returns a [`ModelError::InvalidPermissions`]
/// if the current user does not have permission to manage channels.
///
/// Otherwise will return [`Error::Http`] if the current user lacks permission.
///
/// [Manage Channels]: Permissions::MANAGE_CHANNELS
pub async fn create_channel(
&self,
cache_http: impl CacheHttp,
f: impl FnOnce(&mut CreateChannel) -> &mut CreateChannel,
) -> Result<GuildChannel> {
#[cfg(feature = "cache")]
{
if cache_http.cache().is_some() {
let req = Permissions::MANAGE_CHANNELS;
if !self.has_perms(&cache_http, req).await {
return Err(Error::Model(ModelError::InvalidPermissions(req)));
}
}
}
self.id.create_channel(cache_http.http(), f).await
}
/// Creates an emoji in the guild with a name and base64-encoded image. The
/// [`utils::read_image`] function is provided for you as a simple method to
/// read an image and encode it into base64, if you are reading from the
/// filesystem.
///
/// The name of the emoji must be at least 2 characters long and can only
/// contain alphanumeric characters and underscores.
///
/// Requires the [Manage Emojis and Stickers] permission.
///
/// # Examples
///
/// See the [`EditProfile::avatar`] example for an in-depth example as to
/// how to read an image from the filesystem and encode it as base64. Most
/// of the example can be applied similarly for this method.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission.
///
/// [`EditProfile::avatar`]: crate::builder::EditProfile::avatar
/// [`utils::read_image`]: crate::utils::read_image
/// [Manage Emojis and Stickers]: Permissions::MANAGE_EMOJIS_AND_STICKERS
#[inline]
pub async fn create_emoji(
&self,
http: impl AsRef<Http>,
name: &str,
image: &str,
) -> Result<Emoji> {
self.id.create_emoji(&http, name, image).await
}
/// Creates an integration for the guild.
///
/// Requires the [Manage Guild] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission.
///
/// [Manage Guild]: Permissions::MANAGE_GUILD
#[inline]
pub async fn create_integration<I>(
&self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>,
kind: &str,
) -> Result<()> {
self.id.create_integration(&http, integration_id, kind).await
}
/// Creates a guild specific [`Command`]
///
/// **Note**: Unlike global `Command`s, guild commands will update instantly.
///
/// # Errors
///
/// Returns the same possible errors as `create_global_application_command`.
#[allow(clippy::missing_errors_doc)]
#[inline]
pub async fn create_application_command<F>(
&self,
http: impl AsRef<Http>,
f: F,
) -> Result<Command>
where
F: FnOnce(&mut CreateApplicationCommand) -> &mut CreateApplicationCommand,
{
self.id.create_application_command(http, f).await
}
/// Overrides all guild application commands.
///
/// [`create_application_command`]: Self::create_application_command
///
/// # Errors
///
/// If there is an error, it will be either [`Error::Http`] or [`Error::Json`].
pub async fn set_application_commands<F>(
&self,
http: impl AsRef<Http>,
f: F,
) -> Result<Vec<Command>>
where
F: FnOnce(&mut CreateApplicationCommands) -> &mut CreateApplicationCommands,
{
self.id.set_application_commands(http, f).await
}
/// Creates a guild specific [`CommandPermission`].
///
/// **Note**: It will update instantly.
///
/// # Errors
///
/// If there is an error, it will be either [`Error::Http`] or [`Error::Json`].
pub async fn create_application_command_permission<F>(
&self,
http: impl AsRef<Http>,
command_id: CommandId,
f: F,
) -> Result<CommandPermission>
where
F: FnOnce(
&mut CreateApplicationCommandPermissionsData,
) -> &mut CreateApplicationCommandPermissionsData,
{
self.id.create_application_command_permission(http, command_id, f).await
}
/// Overrides all application commands permissions.
///
/// # Errors
///
/// If there is an error, it will be either [`Error::Http`] or [`Error::Json`].
pub async fn set_application_commands_permissions<F>(
&self,
http: impl AsRef<Http>,
f: F,
) -> Result<Vec<CommandPermission>>
where
F: FnOnce(
&mut CreateApplicationCommandsPermissions,
) -> &mut CreateApplicationCommandsPermissions,
{
self.id.set_application_commands_permissions(http, f).await
}
/// Get all guild application commands.
///
/// # Errors
///
/// If there is an error, it will be either [`Error::Http`] or [`Error::Json`].
pub async fn get_application_commands(&self, http: impl AsRef<Http>) -> Result<Vec<Command>> {
self.id.get_application_commands(http).await
}
/// Get a specific guild application command by its Id.
///
/// # Errors
///
/// If there is an error, it will be either [`Error::Http`] or [`Error::Json`].
pub async fn get_application_command(
&self,
http: impl AsRef<Http>,
command_id: CommandId,
) -> Result<Command> {
self.id.get_application_command(http, command_id).await
}
/// Edit guild application command by its Id.
///
/// # Errors
///
/// If there is an error, it will be either [`Error::Http`] or [`Error::Json`].
pub async fn edit_application_command<F>(
&self,
http: impl AsRef<Http>,
command_id: CommandId,
f: F,
) -> Result<Command>
where
F: FnOnce(&mut CreateApplicationCommand) -> &mut CreateApplicationCommand,
{
self.id.edit_application_command(http, command_id, f).await
}
/// Delete guild application command by its Id.
///
/// # Errors
///
/// If there is an error, it will be either [`Error::Http`] or [`Error::Json`].
pub async fn delete_application_command(
&self,
http: impl AsRef<Http>,
command_id: CommandId,
) -> Result<()> {
self.id.delete_application_command(http, command_id).await
}
/// Get all guild application commands permissions only.
///
/// # Errors
///
/// If there is an error, it will be either [`Error::Http`] or [`Error::Json`].
pub async fn get_application_commands_permissions(
&self,
http: impl AsRef<Http>,
) -> Result<Vec<CommandPermission>> {
self.id.get_application_commands_permissions(http).await
}
/// Get permissions for specific guild application command by its Id.
///
/// # Errors
///
/// If there is an error, it will be either [`Error::Http`] or [`Error::Json`].
pub async fn get_application_command_permissions(
&self,
http: impl AsRef<Http>,
command_id: CommandId,
) -> Result<CommandPermission> {
self.id.get_application_command_permissions(http, command_id).await
}
/// Creates a new role in the guild with the data set, if any.
///
/// **Note**: Requires the [Manage Roles] permission.
///
/// # Examples
///
/// Create a role which can be mentioned, with the name 'test':
///
/// ```rust,ignore
/// // assuming a `guild` has been bound
///
/// let role = guild.create_role(&http, |r| r.hoist(true).name("role")).await;
/// ```
///
/// # Errors
///
/// If the `cache` is enabled, returns a [`ModelError::InvalidPermissions`]
/// if the current user does not have permission to manage roles.
///
/// Otherwise will return [`Error::Http`] if the current user does
/// not have permission.
///
/// [Manage Roles]: Permissions::MANAGE_ROLES
pub async fn create_role<F>(&self, cache_http: impl CacheHttp, f: F) -> Result<Role>
where
F: FnOnce(&mut EditRole) -> &mut EditRole,
{
#[cfg(feature = "cache")]
{
if cache_http.cache().is_some() {
let req = Permissions::MANAGE_ROLES;
if !self.has_perms(&cache_http, req).await {
return Err(Error::Model(ModelError::InvalidPermissions(req)));
}
}
}
self.id.create_role(cache_http.http(), f).await
}
/// Creates a new scheduled event in the guild with the data set, if any.
///
/// **Note**: Requires the [Manage Events] permission.
///
/// # Errors
///
/// If the `cache` is enabled, returns a [`ModelError::InvalidPermissions`] if the current user
/// does not have permission to manage scheduled events.
///
/// Otherwise will return [`Error::Http`] if the current user does not have permission.
///
/// [Manage Events]: Permissions::MANAGE_EVENTS
pub async fn create_scheduled_event<F>(
&self,
cache_http: impl CacheHttp,
f: F,
) -> Result<ScheduledEvent>
where
F: FnOnce(&mut CreateScheduledEvent) -> &mut CreateScheduledEvent,
{
#[cfg(feature = "cache")]
{
if cache_http.cache().is_some() {
let req = Permissions::MANAGE_EVENTS;
if !self.has_perms(&cache_http, req).await {
return Err(Error::Model(ModelError::InvalidPermissions(req)));
}
}
}
self.id.create_scheduled_event(cache_http.http(), f).await
}
/// Creates a new sticker in the guild with the data set, if any.
///
/// **Note**: Requires the [Manage Emojis and Stickers] permission.
///
/// # Errors
///
/// If the `cache` is enabled, returns a [`ModelError::InvalidPermissions`]
/// if the current user does not have permission to manage roles.
///
/// [Manage Emojis and Stickers]: crate::model::permissions::Permissions::MANAGE_EMOJIS_AND_STICKERS
pub async fn create_sticker<'a, F>(&self, cache_http: impl CacheHttp, f: F) -> Result<Sticker>
where
for<'b> F: FnOnce(&'b mut CreateSticker<'a>) -> &'b mut CreateSticker<'a>,
{
#[cfg(feature = "cache")]
{
if cache_http.cache().is_some() {
let req = Permissions::MANAGE_EMOJIS_AND_STICKERS;
if !self.has_perms(&cache_http, req).await {
return Err(Error::Model(ModelError::InvalidPermissions(req)));
}
}
}
self.id.create_sticker(cache_http.http(), f).await
}
/// Deletes the current guild if the current user is the owner of the
/// guild.
///
/// **Note**: Requires the current user to be the owner of the guild.
///
/// # Errors
///
/// If the `cache` is enabled, then returns a [`ModelError::InvalidUser`]
/// if the current user is not the guild owner.
///
/// Otherwise returns [`Error::Http`] if the current user is not the
/// owner of the guild.
pub async fn delete(&self, cache_http: impl CacheHttp) -> Result<PartialGuild> {
#[cfg(feature = "cache")]
{
if let Some(cache) = cache_http.cache() {
if self.owner_id != cache.current_user().id {
let req = Permissions::MANAGE_GUILD;
return Err(Error::Model(ModelError::InvalidPermissions(req)));
}
}
}
self.id.delete(cache_http.http()).await
}
/// Deletes an [`Emoji`] from the guild.
///
/// Requires the [Manage Emojis and Stickers] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission.
///
/// [Manage Emojis and Stickers]: Permissions::MANAGE_EMOJIS_AND_STICKERS
#[inline]
pub async fn delete_emoji(
&self,
http: impl AsRef<Http>,
emoji_id: impl Into<EmojiId>,
) -> Result<()> {
self.id.delete_emoji(&http, emoji_id).await
}
/// Deletes an integration by Id from the guild.
///
/// Requires the [Manage Guild] permission.
///
/// # Errors
///
/// Returns an [`Error::Http`] if the current user lacks permission,
/// or if an Integration with that Id does not exist.
///
/// [Manage Guild]: Permissions::MANAGE_GUILD
#[inline]
pub async fn delete_integration(
&self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>,
) -> Result<()> {
self.id.delete_integration(&http, integration_id).await
}
/// Deletes a [`Role`] by Id from the guild.
///
/// Also see [`Role::delete`] if you have the `cache` and `model` features
/// enabled.
///
/// Requires the [Manage Roles] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission
/// to delete the role.
///
/// [Manage Roles]: Permissions::MANAGE_ROLES
#[inline]
pub async fn delete_role(
&self,
http: impl AsRef<Http>,
role_id: impl Into<RoleId>,
) -> Result<()> {
self.id.delete_role(&http, role_id).await
}
/// Deletes a [Scheduled Event] by Id from the guild.
///
/// Requires the [Manage Events] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission to delete the scheduled event.
///
/// [Scheduled Event]: ScheduledEvent
/// [Manage Events]: Permissions::MANAGE_EVENTS
#[inline]
pub async fn delete_scheduled_event(
&self,
http: impl AsRef<Http>,
event_id: impl Into<ScheduledEventId>,
) -> Result<()> {
self.id.delete_scheduled_event(&http, event_id).await
}
/// Deletes a [`Sticker`] by Id from the guild.
///
/// Requires the [Manage Emojis and Stickers] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission
/// to delete the sticker.
///
/// [Manage Emojis and Stickers]: crate::model::permissions::Permissions::MANAGE_EMOJIS_AND_STICKERS
#[inline]
pub async fn delete_sticker(
&self,
http: impl AsRef<Http>,
sticker_id: impl Into<StickerId>,
) -> Result<()> {
self.id.delete_sticker(&http, sticker_id).await
}
/// Edits the current guild with new data where specified.
///
/// Refer to [`EditGuild`]'s documentation for a full list of methods.
///
/// **Note**: Requires the current user to have the [Manage Guild]
/// permission.
///
/// # Examples
///
/// Change a guild's icon using a file name "icon.png":
///
/// ```rust,ignore
/// use serenity::utils;
///
/// // We are using read_image helper function from utils.
/// let base64_icon = utils::read_image("./icon.png")
/// .expect("Failed to read image");
///
/// guild.edit(|g| g.icon(base64_icon));
/// ```
///
/// # Errors
///
/// If the `cache` is enabled, returns a [`ModelError::InvalidPermissions`]
/// if the current user does not have permission to edit the guild.
///
/// Otherwise will return [`Error::Http`] if the current user does not have
/// permission.
///
/// [Manage Guild]: Permissions::MANAGE_GUILD
pub async fn edit<F>(&mut self, cache_http: impl CacheHttp, f: F) -> Result<()>
where
F: FnOnce(&mut EditGuild) -> &mut EditGuild,
{
#[cfg(feature = "cache")]
{
if cache_http.cache().is_some() {
let req = Permissions::MANAGE_GUILD;
if !self.has_perms(&cache_http, req).await {
return Err(Error::Model(ModelError::InvalidPermissions(req)));
}
}
}
match self.id.edit(cache_http.http(), f).await {
Ok(guild) => {
self.afk_channel_id = guild.afk_channel_id;
self.afk_timeout = guild.afk_timeout;
self.default_message_notifications = guild.default_message_notifications;
self.emojis = guild.emojis;
self.features = guild.features;
self.icon = guild.icon;
self.mfa_level = guild.mfa_level;
self.name = guild.name;
self.owner_id = guild.owner_id;
self.roles = guild.roles;
self.splash = guild.splash;
self.verification_level = guild.verification_level;
Ok(())
},
Err(why) => Err(why),
}
}
/// Edits an [`Emoji`]'s name in the guild.
///
/// Also see [`Emoji::edit`] if you have the `cache` and `model` features
/// enabled.
///
/// Requires the [Manage Emojis and Stickers] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission.
///
/// [Manage Emojis and Stickers]: Permissions::MANAGE_EMOJIS_AND_STICKERS
#[inline]
pub async fn edit_emoji(
&self,
http: impl AsRef<Http>,
emoji_id: impl Into<EmojiId>,
name: &str,
) -> Result<Emoji> {
self.id.edit_emoji(&http, emoji_id, name).await
}
/// Edits the properties of member of the guild, such as muting or
/// nicknaming them. Returns the new member.
///
/// Refer to [`EditMember`]'s documentation for a full list of methods and
/// permission restrictions.
///
/// # Examples
///
/// Mute a member and set their roles to just one role with a predefined Id:
///
/// ```rust,ignore
/// guild.edit_member(user_id, |m| m.mute(true).roles(&vec![role_id]));
/// ```
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks the necessary permissions.
#[inline]
pub async fn edit_member<F>(
&self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>,
f: F,
) -> Result<Member>
where
F: FnOnce(&mut EditMember) -> &mut EditMember,
{
self.id.edit_member(&http, user_id, f).await
}
/// Edits the current user's nickname for the guild.
///
/// Pass [`None`] to reset the nickname.
///
/// **Note**: Requires the [Change Nickname] permission.
///
/// # Errors
///
/// If the `cache` is enabled, returns a [`ModelError::InvalidPermissions`]
/// if the current user does not have permission to change their own
/// nickname.
///
/// Otherwise will return [`Error::Http`] if the current user lacks permission.
///
/// [Change Nickname]: Permissions::CHANGE_NICKNAME
pub async fn edit_nickname(
&self,
cache_http: impl CacheHttp,
new_nickname: Option<&str>,
) -> Result<()> {
#[cfg(feature = "cache")]
{
if cache_http.cache().is_some() {
let req = Permissions::CHANGE_NICKNAME;
if !self.has_perms(&cache_http, req).await {
return Err(Error::Model(ModelError::InvalidPermissions(req)));
}
}
}
self.id.edit_nickname(cache_http.http(), new_nickname).await
}
/// Edits a role, optionally setting its fields.
///
/// Requires the [Manage Roles] permission.
///
/// # Examples
///
/// Make a role hoisted:
///
/// ```rust,ignore
/// guild.edit_role(&context, RoleId(7), |r| r.hoist(true));
/// ```
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission.
///
/// [Manage Roles]: Permissions::MANAGE_ROLES
#[inline]
pub async fn edit_role<F>(
&self,
http: impl AsRef<Http>,
role_id: impl Into<RoleId>,
f: F,
) -> Result<Role>
where
F: FnOnce(&mut EditRole) -> &mut EditRole,
{
self.id.edit_role(&http, role_id, f).await
}
/// Edits the order of [`Role`]s
/// Requires the [Manage Roles] permission.
///
/// # Examples
///
/// Change the order of a role:
///
/// ```rust,ignore
/// use serenity::model::id::RoleId;
/// guild.edit_role_position(&context, RoleId(8), 2);
/// ```
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission.
///
/// [Manage Roles]: Permissions::MANAGE_ROLES
#[inline]
pub async fn edit_role_position(
&self,
http: impl AsRef<Http>,
role_id: impl Into<RoleId>,
position: u64,
) -> Result<Vec<Role>> {
self.id.edit_role_position(&http, role_id, position).await
}
/// Modifies a scheduled event in the guild with the data set, if any.
///
/// **Note**: Requires the [Manage Events] permission.
///
/// # Errors
///
/// If the `cache` is enabled, returns a [`ModelError::InvalidPermissions`] if the current user
/// does not have permission to manage roles.
///
/// Otherwise will return [`Error::Http`] if the current user does not have permission.
///
/// [Manage Events]: Permissions::MANAGE_EVENTS
pub async fn edit_scheduled_event<F>(
&self,
http: impl AsRef<Http>,
event_id: impl Into<ScheduledEventId>,
f: F,
) -> Result<ScheduledEvent>
where
F: FnOnce(&mut EditScheduledEvent) -> &mut EditScheduledEvent,
{
self.id.edit_scheduled_event(&http, event_id, f).await
}
/// Edits a sticker, optionally setting its fields.
///
/// Requires the [Manage Emojis and Stickers] permission.
///
/// # Examples
///
/// Rename a sticker:
///
/// ```rust,ignore
/// guild.edit_sticker(&context, StickerId(7), |r| r.name("Bun bun meow"));
/// ```
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission.
///
/// [Manage Emojis and Stickers]: crate::model::permissions::Permissions::MANAGE_EMOJIS_AND_STICKERS
#[inline]
pub async fn edit_sticker<F>(
&self,
http: impl AsRef<Http>,
sticker_id: impl Into<StickerId>,
f: F,
) -> Result<Sticker>
where
F: FnOnce(&mut EditSticker) -> &mut EditSticker,
{
self.id.edit_sticker(&http, sticker_id, f).await
}
/// Edits the [`GuildWelcomeScreen`].
///
/// # Errors
///
/// Returns an [`Error::Http`] if some mandatory fields are not provided.
pub async fn edit_welcome_screen<F>(
&self,
http: impl AsRef<Http>,
f: F,
) -> Result<GuildWelcomeScreen>
where
F: FnOnce(&mut EditGuildWelcomeScreen) -> &mut EditGuildWelcomeScreen,
{
self.id.edit_welcome_screen(http, f).await
}
/// Edits the [`GuildWidget`].
///
/// # Errors
///
/// Returns an [`Error::Http`] if the bot does not have the `MANAGE_GUILD`
/// permission.
pub async fn edit_widget<F>(&self, http: impl AsRef<Http>, f: F) -> Result<GuildWidget>
where
F: FnOnce(&mut EditGuildWidget) -> &mut EditGuildWidget,
{
self.id.edit_widget(http, f).await
}
/// Gets a partial amount of guild data by its Id.
///
/// **Note**: This will not be a [`Guild`], as the REST API does not send
/// all data with a guild retrieval.
///
/// # Errors
///
/// Returns an [`Error::Http`] if the current user is not in the guild.
#[inline]
pub async fn get(http: impl AsRef<Http>, guild_id: impl Into<GuildId>) -> Result<PartialGuild> {
guild_id.into().to_partial_guild(&http).await
}
/// Returns which of two [`User`]s has a higher [`Member`] hierarchy.
///
/// Hierarchy is essentially who has the [`Role`] with the highest
/// [`position`].
///
/// Returns [`None`] if at least one of the given users' member instances
/// is not present. Returns [`None`] if the users have the same hierarchy, as
/// neither are greater than the other.
///
/// If both user IDs are the same, [`None`] is returned. If one of the users
/// is the guild owner, their ID is returned.
///
/// [`position`]: Role::position
#[cfg(feature = "cache")]
#[inline]
pub fn greater_member_hierarchy(
&self,
cache: impl AsRef<Cache>,
lhs_id: impl Into<UserId>,
rhs_id: impl Into<UserId>,
) -> Option<UserId> {
self._greater_member_hierarchy(&cache, lhs_id.into(), rhs_id.into())
}
#[cfg(feature = "cache")]
fn _greater_member_hierarchy(
&self,
cache: impl AsRef<Cache>,
lhs_id: UserId,
rhs_id: UserId,
) -> Option<UserId> {
// Check that the IDs are the same. If they are, neither is greater.
if lhs_id == rhs_id {
return None;
}
// Check if either user is the guild owner.
if lhs_id == self.owner_id {
return Some(lhs_id);
} else if rhs_id == self.owner_id {
return Some(rhs_id);
}
let lhs = self.members.get(&lhs_id)?.highest_role_info(&cache).unwrap_or((RoleId(0), 0));
let rhs = self.members.get(&rhs_id)?.highest_role_info(&cache).unwrap_or((RoleId(0), 0));
// If LHS and RHS both have no top position or have the same role ID,
// then no one wins.
if (lhs.1 == 0 && rhs.1 == 0) || (lhs.0 == rhs.0) {
return None;
}
// If LHS's top position is higher than RHS, then LHS wins.
if lhs.1 > rhs.1 {
return Some(lhs_id);
}
// If RHS's top position is higher than LHS, then RHS wins.
if rhs.1 > lhs.1 {
return Some(rhs_id);
}
// If LHS and RHS both have the same position, but LHS has the lower
// role ID, then LHS wins.
//
// If RHS has the higher role ID, then RHS wins.
if lhs.1 == rhs.1 && lhs.0 < rhs.0 {
Some(lhs_id)
} else {
Some(rhs_id)
}
}
/// Returns the formatted URL of the guild's icon, if one exists.
///
/// This will produce a WEBP image URL, or GIF if the guild has a GIF icon.
#[must_use]
pub fn icon_url(&self) -> Option<String> {
self.icon.as_ref().map(|icon| {
let ext = if icon.starts_with("a_") { "gif" } else { "webp" };
cdn!("/icons/{}/{}.{}", self.id, icon, ext)
})
}
/// Gets all [`Emoji`]s of this guild via HTTP.
///
/// # Errors
///
/// Returns [`Error::Http`] if the guild is unavailable
#[inline]
pub async fn emojis(&self, http: impl AsRef<Http>) -> Result<Vec<Emoji>> {
self.id.emojis(http).await
}
/// Gets an [`Emoji`] of this guild by its ID via HTTP.
///
/// # Errors
///
/// Returns an [`Error::Http`] if an emoji with that Id does not exist
/// in the guild, or if the guild is unavailable.
///
/// May also return [`Error::Json`] if there is an error in deserializing
/// the API response.
#[inline]
pub async fn emoji(&self, http: impl AsRef<Http>, emoji_id: EmojiId) -> Result<Emoji> {
self.id.emoji(http, emoji_id).await
}
/// Gets all integration of the guild.
///
/// **Note**: Requires the [Manage Guild] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user does not have permission
/// to see integrations.
///
/// May also return [`Error::Json`] if there is an error in deserializing
/// the API response.
///
/// [Manage Guild]: Permissions::MANAGE_GUILD
#[inline]
pub async fn integrations(&self, http: impl AsRef<Http>) -> Result<Vec<Integration>> {
self.id.integrations(&http).await
}
/// Retrieves the active invites for the guild.
///
/// **Note**: Requires the [Manage Guild] permission.
///
/// # Errors
///
/// If the `cache` is enabled, returns [`ModelError::InvalidPermissions`]
/// if the current user does not have permission to see invites.
///
/// Otherwise will return [`Error::Http`] if the current user does not have
/// permission.
///
/// [Manage Guild]: Permissions::MANAGE_GUILD
pub async fn invites(&self, cache_http: impl CacheHttp) -> Result<Vec<RichInvite>> {
#[cfg(feature = "cache")]
{
if cache_http.cache().is_some() {
let req = Permissions::MANAGE_GUILD;
if !self.has_perms(&cache_http, req).await {
return Err(Error::Model(ModelError::InvalidPermissions(req)));
}
}
}
self.id.invites(cache_http.http()).await
}
/// Checks if the guild is 'large'. A guild is considered large if it has
/// more than 250 members.
#[inline]
#[must_use]
pub fn is_large(&self) -> bool {
self.members.len() > LARGE_THRESHOLD as usize
}
/// Kicks a [`Member`] from the guild.
///
/// Requires the [Kick Members] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the member cannot be kicked by
/// the current user.
///
/// [Kick Members]: Permissions::KICK_MEMBERS
#[inline]
pub async fn kick(&self, http: impl AsRef<Http>, user_id: impl Into<UserId>) -> Result<()> {
self.id.kick(&http, user_id).await
}
/// # Errors
///
/// In addition to the reasons [`Self::kick`] may return an error,
/// may also return an error if the reason is too long.
#[inline]
pub async fn kick_with_reason(
&self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>,
reason: &str,
) -> Result<()> {
self.id.kick_with_reason(&http, user_id, reason).await
}
/// Leaves the guild.
///
/// # Errors
///
/// May return an [`Error::Http`] if the current user
/// cannot leave the guild, or currently is not in the guild.
#[inline]
pub async fn leave(&self, http: impl AsRef<Http>) -> Result<()> {
self.id.leave(&http).await
}
/// Gets a user's [`Member`] for the guild by Id.
///
/// # Errors
///
/// Returns an [`Error::Http`] if the user is not in
/// the guild or if the guild is otherwise unavailable.
#[inline]
pub async fn member(
&self,
cache_http: impl CacheHttp,
user_id: impl Into<UserId>,
) -> Result<Member> {
self.id.member(cache_http, user_id).await
}
/// Gets a list of the guild's members.
///
/// Optionally pass in the `limit` to limit the number of results.
/// Minimum value is 1, maximum and default value is 1000.
///
/// Optionally pass in `after` to offset the results by a [`User`]'s Id.
///
/// # Errors
///
/// Returns an [`Error::Http`] if the API returns an error, may also
/// return [`Error::NotInRange`] if the input is not within range.
///
/// [`User`]: crate::model::user::User
#[inline]
pub async fn members(
&self,
http: impl AsRef<Http>,
limit: Option<u64>,
after: impl Into<Option<UserId>>,
) -> Result<Vec<Member>> {
self.id.members(&http, limit, after).await
}
/// Gets a list of all the members (satisfying the status provided to the function) in this
/// guild.
#[must_use]
pub fn members_with_status(&self, status: OnlineStatus) -> Vec<&Member> {
let mut members = vec![];
for (&id, member) in &self.members {
if let Some(presence) = self.presences.get(&id) {
if status == presence.status {
members.push(member);
}
}
}
members
}
/// Retrieves the first [`Member`] found that matches the name - with an
/// optional discriminator - provided.
///
/// Searching with a discriminator given is the most precise form of lookup,
/// as no two people can share the same username *and* discriminator.
///
/// If a member can not be found by username or username#discriminator,
/// then a search will be done for the nickname. When searching by nickname,
/// the hash (`#`) and everything after it is included in the search.
///
/// The following are valid types of searches:
///
/// - **username**: "zey"
/// - **username and discriminator**: "zey#5479"
///
/// **Note**: This will only search members that are cached. If you want to
/// search all members in the guild via the Http API, use
/// [`Self::search_members`].
#[must_use]
pub fn member_named(&self, name: &str) -> Option<&Member> {
let (username, discrim) = match crate::utils::parse_user_tag(name) {
Some((username, discrim)) => (username, Some(discrim)),
None => (name, None),
};
for member in self.members.values() {
if member.user.name == username
&& discrim.map_or(true, |d| member.user.discriminator == d)
{
return Some(member);
}
}
self.members.values().find(|member| member.nick.as_ref().map_or(false, |nick| nick == name))
}
/// Retrieves all [`Member`] that start with a given [`String`].
///
/// `sorted` decides whether the best early match of the `prefix`
/// should be the criteria to sort the result.
/// For the `prefix` "zey" and the unsorted result:
/// - "zeya", "zeyaa", "zeyla", "zeyzey", "zeyzeyzey"
/// It would be sorted:
/// - "zeya", "zeyaa", "zeyla", "zeyzey", "zeyzeyzey"
///
/// **Locking**:
/// First collects a [`Member`]'s [`User`]-name by read-locking all inner
/// [`User`]s, and then sorts. This ensures that no name is being changed
/// after being sorted in the originally correct position.
/// However, since the read-locks are dropped after borrowing the name,
/// the names might have been changed by the user, the sorted list cannot
/// account for this.
///
/// **Note**: This will only search members that are cached. If you want to
/// search all members in the guild via the Http API, use
/// [`Self::search_members`].
pub async fn members_starting_with(
&self,
prefix: &str,
case_sensitive: bool,
sorted: bool,
) -> Vec<(&Member, String)> {
fn starts_with(prefix: &str, case_sensitive: bool, name: &str) -> bool {
case_sensitive && name.starts_with(prefix)
|| !case_sensitive && starts_with_case_insensitive(name, prefix)
}
let mut members = futures::stream::iter(self.members.values())
.filter_map(|member| async move {
let username = &member.user.name;
if starts_with(prefix, case_sensitive, username) {
Some((member, username.to_string()))
} else {
match member.nick {
Some(ref nick) => {
if starts_with(prefix, case_sensitive, nick) {
Some((member, nick.to_string()))
} else {
None
}
},
None => None,
}
}
})
.collect::<Vec<(&Member, String)>>()
.await;
if sorted {
members.sort_by(|a, b| closest_to_origin(prefix, &a.1[..], &b.1[..]));
}
members
}
/// Retrieves all [`Member`] containing a given [`String`] as
/// either username or nick, with a priority on username.
///
/// If the substring is "yla", following results are possible:
/// - "zeyla", "meiyla", "yladenisyla"
/// If 'case_sensitive' is false, the following are not found:
/// - "zeYLa", "meiyLa", "LYAdenislyA"
///
/// `sorted` decides whether the best early match of the search-term
/// should be the criteria to sort the result.
/// It will look at the account name first, if that does not fit the
/// search-criteria `substring`, the display-name will be considered.
/// For the `substring` "zey" and the unsorted result:
/// - "azey", "zey", "zeyla", "zeylaa", "zeyzeyzey"
/// It would be sorted:
/// - "zey", "azey", "zeyla", "zeylaa", "zeyzeyzey"
///
/// **Note**: Due to two fields of a [`Member`] being candidates for
/// the searched field, setting `sorted` to `true` will result in an overhead,
/// as both fields have to be considered again for sorting.
///
/// **Locking**:
/// First collects a [`Member`]'s [`User`]-name by read-locking all inner
/// [`User`]s, and then sorts. This ensures that no name is being changed
/// after being sorted in the originally correct position.
/// However, since the read-locks are dropped after borrowing the name,
/// the names might have been changed by the user, the sorted list cannot
/// account for this.
///
/// **Note**: This will only search members that are cached. If you want to
/// search all members in the guild via the Http API, use
/// [`Self::search_members`].
pub async fn members_containing(
&self,
substring: &str,
case_sensitive: bool,
sorted: bool,
) -> Vec<(&Member, String)> {
fn contains(substring: &str, case_sensitive: bool, name: &str) -> bool {
case_sensitive && name.contains(substring)
|| !case_sensitive && contains_case_insensitive(name, substring)
}
let mut members = futures::stream::iter(self.members.values())
.filter_map(|member| async move {
let username = &member.user.name;
if contains(substring, case_sensitive, username) {
Some((member, username.to_string()))
} else {
match member.nick {
Some(ref nick) => {
if contains(substring, case_sensitive, nick) {
Some((member, nick.to_string()))
} else {
None
}
},
None => None,
}
}
})
.collect::<Vec<(&Member, String)>>()
.await;
if sorted {
members.sort_by(|a, b| closest_to_origin(substring, &a.1[..], &b.1[..]));
}
members
}
/// Retrieves a tuple of [`Member`]s containing a given [`String`] in
/// their username as the first field and the name used for sorting
/// as the second field.
///
/// If the substring is "yla", following results are possible:
/// - "zeyla", "meiyla", "yladenisyla"
/// If 'case_sensitive' is false, the following are not found:
/// - "zeYLa", "meiyLa", "LYAdenislyA"
///
/// `sort` decides whether the best early match of the search-term
/// should be the criteria to sort the result.
/// For the `substring` "zey" and the unsorted result:
/// - "azey", "zey", "zeyla", "zeylaa", "zeyzeyzey"
/// It would be sorted:
/// - "zey", "azey", "zeyla", "zeylaa", "zeyzeyzey"
///
/// **Locking**:
/// First collects a [`Member`]'s [`User`]-name by read-locking all inner
/// [`User`]s, and then sorts. This ensures that no name is being changed
/// after being sorted in the originally correct position.
/// However, since the read-locks are dropped after borrowing the name,
/// the names might have been changed by the user, the sorted list cannot
/// account for this.
///
/// **Note**: This will only search members that are cached. If you want to
/// search all members in the guild via the Http API, use
/// [`Self::search_members`].
pub async fn members_username_containing(
&self,
substring: &str,
case_sensitive: bool,
sorted: bool,
) -> Vec<(&Member, String)> {
let mut members = futures::stream::iter(self.members.values())
.filter_map(|member| async move {
let name = &member.user.name;
if (case_sensitive && name.contains(substring))
|| contains_case_insensitive(name, substring)
{
Some((member, name.to_string()))
} else {
None
}
})
.collect::<Vec<(&Member, String)>>()
.await;
if sorted {
members.sort_by(|a, b| closest_to_origin(substring, &a.1[..], &b.1[..]));
}
members
}
/// Retrieves all [`Member`] containing a given [`String`] in
/// their nick.
///
/// If the substring is "yla", following results are possible:
/// - "zeyla", "meiyla", "yladenisyla"
/// If 'case_sensitive' is false, the following are not found:
/// - "zeYLa", "meiyLa", "LYAdenislyA"
///
/// `sort` decides whether the best early match of the search-term
/// should be the criteria to sort the result.
/// For the `substring` "zey" and the unsorted result:
/// - "azey", "zey", "zeyla", "zeylaa", "zeyzeyzey"
/// It would be sorted:
/// - "zey", "azey", "zeyla", "zeylaa", "zeyzeyzey"
///
/// **Note**: Instead of panicking, when sorting does not find
/// a nick, the username will be used (this should never happen).
///
/// **Locking**:
/// First collects a [`Member`]'s nick directly or by read-locking all inner
/// [`User`]s (in case of no nick, see note above), and then sorts.
/// This ensures that no name is being changed after being sorted in the
/// originally correct position.
/// However, since the read-locks are dropped after borrowing the name,
/// the names might have been changed by the user, the sorted list cannot
/// account for this.
///
/// **Note**: This will only search members that are cached. If you want to
/// search all members in the guild via the Http API, use
/// [`Self::search_members`].
pub async fn members_nick_containing(
&self,
substring: &str,
case_sensitive: bool,
sorted: bool,
) -> Vec<(&Member, String)> {
let mut members = futures::stream::iter(self.members.values())
.filter_map(|member| async move {
let nick = match member.nick {
Some(ref nick) => nick.to_string(),
None => member.user.name.to_string(),
};
if case_sensitive && nick.contains(substring)
|| !case_sensitive && contains_case_insensitive(&nick, substring)
{
Some((member, nick))
} else {
None
}
})
.collect::<Vec<(&Member, String)>>()
.await;
if sorted {
members.sort_by(|a, b| closest_to_origin(substring, &a.1[..], &b.1[..]));
}
members
}
/// Calculate a [`Member`]'s permissions in the guild.
///
/// If member caching is enabled the cache will be checked
/// first. If not found it will resort to an http request.
///
/// Cache is still required to look up roles.
///
/// # Errors
///
/// See [`Guild::member`].
#[inline]
#[cfg(feature = "cache")]
pub async fn member_permissions(
&self,
cache_http: impl CacheHttp,
user_id: impl Into<UserId>,
) -> Result<Permissions> {
self._member_permissions(cache_http, user_id.into()).await
}
#[cfg(feature = "cache")]
async fn _member_permissions(
&self,
cache_http: impl CacheHttp,
user_id: UserId,
) -> Result<Permissions> {
if user_id == self.owner_id {
return Ok(Permissions::all());
}
let member = self.member(cache_http, &user_id).await?;
Ok(self._member_permission_from_member(&member))
}
/// Helper function that's used for getting a [`Member`]'s permissions.
#[cfg(feature = "cache")]
pub(crate) fn _member_permission_from_member(&self, member: &Member) -> Permissions {
if member.user.id == self.owner_id {
return Permissions::all();
}
let everyone = if let Some(everyone) = self.roles.get(&RoleId(self.id.0)) {
everyone
} else {
error!("@everyone role ({}) missing in '{}'", self.id, self.name);
return Permissions::empty();
};
let mut permissions = everyone.permissions;
for role in &member.roles {
if let Some(role) = self.roles.get(role) {
if role.permissions.contains(Permissions::ADMINISTRATOR) {
return Permissions::all();
}
permissions |= role.permissions;
} else {
warn!("{} on {} has non-existent role {:?}", member.user.id, self.id, role,);
}
}
permissions
}
/// Moves a member to a specific voice channel.
///
/// Requires the [Move Members] permission.
///
/// # Errors
///
/// Returns an [`Error::Http`] if the current user
/// lacks permission, or if the member is not currently
/// in a voice channel for this [`Guild`].
///
/// [Move Members]: Permissions::MOVE_MEMBERS
#[inline]
pub async fn move_member(
&self,
http: impl AsRef<Http>,
user_id: impl Into<UserId>,
channel_id: impl Into<ChannelId>,
) -> Result<Member> {
self.id.move_member(&http, user_id, channel_id).await
}
/// Calculate a [`Member`]'s permissions in a given channel in the guild.
///
/// # Errors
///
/// Returns [`Error::Model`] if the [`Member`] has a non-existent role
/// for some reason.
#[inline]
pub fn user_permissions_in(
&self,
channel: &GuildChannel,
member: &Member,
) -> Result<Permissions> {
Self::_user_permissions_in(channel, member, &self.roles, self.owner_id, self.id)
}
/// Helper function that can also be used from [`PartialGuild`].
pub(crate) fn _user_permissions_in(
channel: &GuildChannel,
member: &Member,
roles: &HashMap<RoleId, Role>,
owner_id: UserId,
guild_id: GuildId,
) -> Result<Permissions> {
// The owner has all permissions in all cases.
if member.user.id == owner_id {
return Ok(Self::remove_unnecessary_voice_permissions(channel, Permissions::all()));
}
// Start by retrieving the @everyone role's permissions.
let everyone = if let Some(everyone) = roles.get(&RoleId(guild_id.0)) {
everyone
} else {
error!("@everyone role missing in {}", guild_id,);
return Err(Error::Model(ModelError::RoleNotFound));
};
// Create a base set of permissions, starting with `@everyone`s.
let mut permissions = everyone.permissions;
for &role in &member.roles {
if let Some(role) = roles.get(&role) {
permissions |= role.permissions;
} else {
error!("{} on {} has non-existent role {:?}", member.user.id, guild_id, role);
return Err(Error::Model(ModelError::RoleNotFound));
}
}
// Administrators have all permissions in any channel.
if permissions.contains(Permissions::ADMINISTRATOR) {
return Ok(Self::remove_unnecessary_voice_permissions(channel, Permissions::all()));
}
// Apply the permission overwrites for the channel for each of the
// overwrites that - first - applies to the member's roles, and then
// the member itself.
//
// First apply the denied permission overwrites for each, then apply
// the allowed.
let mut data = Vec::with_capacity(member.roles.len());
// Roles
for overwrite in &channel.permission_overwrites {
if let PermissionOverwriteType::Role(role) = overwrite.kind {
if role.0 != guild_id.0 && !member.roles.contains(&role) {
continue;
}
if let Some(role) = roles.get(&role) {
data.push((role.position, overwrite.deny, overwrite.allow));
}
}
}
data.sort_by(|a, b| a.0.cmp(&b.0));
for overwrite in data {
permissions = (permissions & !overwrite.1) | overwrite.2;
}
// Member
for overwrite in &channel.permission_overwrites {
if PermissionOverwriteType::Member(member.user.id) != overwrite.kind {
continue;
}
permissions = (permissions & !overwrite.deny) | overwrite.allow;
}
// The default channel is always readable.
if channel.id.0 == guild_id.0 {
permissions |= Permissions::VIEW_CHANNEL;
}
Self::remove_unusable_permissions(&mut permissions);
Ok(permissions)
}
/// Calculate a [`Role`]'s permissions in a given channel in the guild.
///
/// # Errors
///
/// Will return an [`Error::Model`] if the [`Role`] or [`Channel`] is not from this [`Guild`].
#[inline]
pub fn role_permissions_in(&self, channel: &GuildChannel, role: &Role) -> Result<Permissions> {
Self::_role_permissions_in(channel, role, self.id)
}
/// Helper function that can also be used from [`PartialGuild`].
pub(crate) fn _role_permissions_in(
channel: &GuildChannel,
role: &Role,
guild_id: GuildId,
) -> Result<Permissions> {
// Fail if the role or channel is not from this guild.
if role.guild_id != guild_id || channel.guild_id != guild_id {
return Err(Error::Model(ModelError::WrongGuild));
}
let mut permissions = role.permissions;
if permissions.contains(Permissions::ADMINISTRATOR) {
return Ok(Self::remove_unnecessary_voice_permissions(channel, Permissions::all()));
}
for overwrite in &channel.permission_overwrites {
if let PermissionOverwriteType::Role(permissions_role_id) = overwrite.kind {
if permissions_role_id == role.id {
permissions = (permissions & !overwrite.deny) | overwrite.allow;
break;
}
}
}
Self::remove_unusable_permissions(&mut permissions);
Ok(permissions)
}
/// Retrieves the count of the number of [`Member`]s that would be pruned
/// with the number of given days.
///
/// See the documentation on [`GuildPrune`] for more information.
///
/// **Note**: Requires the [Kick Members] permission.
///
/// # Errors
///
/// If the `cache` is enabled, returns a [`ModelError::InvalidPermissions`]
/// if the current user does not have permission to kick members.
///
/// Otherwise may return [`Error::Http`] if the current user does not have permission.
/// Can also return [`Error::Json`] if there is an error in deserializing the API response.
///
/// [Kick Members]: Permissions::KICK_MEMBERS
pub async fn prune_count(&self, cache_http: impl CacheHttp, days: u16) -> Result<GuildPrune> {
#[cfg(feature = "cache")]
{
if cache_http.cache().is_some() {
let req = Permissions::KICK_MEMBERS;
if !self.has_perms(&cache_http, req).await {
return Err(Error::Model(ModelError::InvalidPermissions(req)));
}
}
}
self.id.prune_count(cache_http.http(), days).await
}
pub(crate) fn remove_unusable_permissions(permissions: &mut Permissions) {
// No SEND_MESSAGES => no message-sending-related actions
// If the member does not have the `SEND_MESSAGES` permission, then
// throw out message-able permissions.
if !permissions.contains(Permissions::SEND_MESSAGES) {
*permissions &= !(Permissions::SEND_TTS_MESSAGES
| Permissions::MENTION_EVERYONE
| Permissions::EMBED_LINKS
| Permissions::ATTACH_FILES);
}
// If the permission does not have the `VIEW_CHANNEL` permission, then
// throw out actionable permissions.
if !permissions.contains(Permissions::VIEW_CHANNEL) {
*permissions &= !(Permissions::KICK_MEMBERS
| Permissions::BAN_MEMBERS
| Permissions::ADMINISTRATOR
| Permissions::MANAGE_GUILD
| Permissions::CHANGE_NICKNAME
| Permissions::MANAGE_NICKNAMES);
}
}
pub(crate) fn remove_unnecessary_voice_permissions(
channel: &GuildChannel,
mut permissions: Permissions,
) -> Permissions {
// If this is a text channel, then throw out voice permissions.
if channel.kind == ChannelType::Text {
permissions &= !(Permissions::CONNECT
| Permissions::SPEAK
| Permissions::MUTE_MEMBERS
| Permissions::DEAFEN_MEMBERS
| Permissions::MOVE_MEMBERS
| Permissions::USE_VAD
| Permissions::STREAM);
}
permissions
}
/// Re-orders the channels of the guild.
///
/// Although not required, you should specify all channels' positions,
/// regardless of whether they were updated. Otherwise, positioning can
/// sometimes get weird.
///
/// **Note**: Requires the [Manage Channels] permission.
///
/// # Errors
///
/// Returns an [`Error::Http`] if the current user is lacking permission.
///
/// [Manage Channels]: Permissions::MANAGE_CHANNELS
#[inline]
pub async fn reorder_channels<It>(&self, http: impl AsRef<Http>, channels: It) -> Result<()>
where
It: IntoIterator<Item = (ChannelId, u64)>,
{
self.id.reorder_channels(&http, channels).await
}
/// Returns a list of [`Member`]s in a [`Guild`] whose username or nickname
/// starts with a provided string.
///
/// Optionally pass in the `limit` to limit the number of results.
/// Minimum value is 1, maximum and default value is 1000.
///
/// **Note**: Queries are case insensitive.
///
/// # Errors
///
/// Returns an [`Error::Http`] if the API returns an error.
#[inline]
pub async fn search_members(
&self,
http: impl AsRef<Http>,
query: &str,
limit: Option<u64>,
) -> Result<Vec<Member>> {
self.id.search_members(http, query, limit).await
}
/// Fetches a specified scheduled event in the guild, by Id. If `with_user_count` is set to
/// `true`, then the `user_count` field will be populated, indicating the number of users
/// interested in the event.
///
/// **Note**: Requires the [Manage Events] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission, or if the provided Id is
/// invalid.
///
/// [Manage Events]: Permissions::MANAGE_EVENTS
pub async fn scheduled_event(
self,
http: impl AsRef<Http>,
event_id: impl Into<ScheduledEventId>,
with_user_count: bool,
) -> Result<ScheduledEvent> {
self.id.scheduled_event(&http, event_id, with_user_count).await
}
/// Fetches a list of all scheduled events in the guild. If `with_user_count` is set to `true`,
/// then each event returned will have its `user_count` field populated.
///
/// **Note**: Requires the [Manage Events] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission.
///
/// [Manage Events]: Permissions::MANAGE_EVENTS
pub async fn scheduled_events(
self,
http: impl AsRef<Http>,
with_user_count: bool,
) -> Result<Vec<ScheduledEvent>> {
self.id.scheduled_events(&http, with_user_count).await
}
/// Fetches a list of interested users for the specified event.
///
/// If `limit` is left unset, by default at most 100 users are returned.
///
/// **Note**: Requires the [Manage Events] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission, or if the provided Id is
/// invalid.
///
/// [Manage Events]: Permissions::MANAGE_EVENTS
pub async fn scheduled_event_users(
self,
http: impl AsRef<Http>,
event_id: impl Into<ScheduledEventId>,
limit: Option<u64>,
) -> Result<Vec<ScheduledEventUser>> {
self.id.scheduled_event_users(&http, event_id, limit).await
}
/// Fetches a list of interested users for the specified event, with additional options and
/// filtering. See [`Http::get_scheduled_event_users`] for details.
///
/// **Note**: Requires the [Manage Events] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission, or if the provided Id is
/// invalid.
///
/// [Manage Events]: Permissions::MANAGE_EVENTS
pub async fn scheduled_event_users_optioned(
self,
http: impl AsRef<Http>,
event_id: impl Into<ScheduledEventId>,
limit: Option<u64>,
target: Option<UserPagination>,
with_member: Option<bool>,
) -> Result<Vec<ScheduledEventUser>> {
self.id.scheduled_event_users_optioned(&http, event_id, limit, target, with_member).await
}
/// Returns the Id of the shard associated with the guild.
///
/// When the cache is enabled this will automatically retrieve the total
/// number of shards.
///
/// **Note**: When the cache is enabled, this function unlocks the cache to
/// retrieve the total number of shards in use. If you already have the
/// total, consider using [`utils::shard_id`].
///
/// [`utils::shard_id`]: crate::utils::shard_id
#[cfg(all(feature = "cache", feature = "utils"))]
#[inline]
pub fn shard_id(&self, cache: impl AsRef<Cache>) -> u64 {
self.id.shard_id(&cache)
}
/// Returns the Id of the shard associated with the guild.
///
/// When the cache is enabled this will automatically retrieve the total
/// number of shards.
///
/// When the cache is not enabled, the total number of shards being used
/// will need to be passed.
///
/// # Examples
///
/// Retrieve the Id of the shard for a guild with Id `81384788765712384`,
/// using 17 shards:
///
/// ```rust,ignore
/// use serenity::utils;
///
/// // assumes a `guild` has already been bound
///
/// assert_eq!(guild.shard_id(17), 7);
/// ```
#[cfg(all(feature = "utils", not(feature = "cache")))]
#[inline]
#[must_use]
pub fn shard_id(&self, shard_count: u64) -> u64 {
self.id.shard_id(shard_count)
}
/// Returns the formatted URL of the guild's splash image, if one exists.
#[must_use]
pub fn splash_url(&self) -> Option<String> {
self.splash.as_ref().map(|splash| cdn!("/splashes/{}/{}.webp?size=4096", self.id, splash))
}
/// Starts an integration sync for the given integration Id.
///
/// Requires the [Manage Guild] permission.
///
/// # Errors
///
/// Returns an [`Error::Http`] if the current user does not have permission,
/// or if an [`Integration`] with that Id does not exist.
///
/// [Manage Guild]: Permissions::MANAGE_GUILD
#[inline]
pub async fn start_integration_sync(
&self,
http: impl AsRef<Http>,
integration_id: impl Into<IntegrationId>,
) -> Result<()> {
self.id.start_integration_sync(&http, integration_id).await
}
/// Starts a prune of [`Member`]s.
///
/// See the documentation on [`GuildPrune`] for more information.
///
/// **Note**: Requires the [Kick Members] permission.
///
/// # Errors
///
/// If the `cache` is enabled, returns a [`ModelError::InvalidPermissions`]
/// if the current user does not have permission to kick members.
///
/// Otherwise will return [`Error::Http`] if the current user does not have
/// permission.
///
/// Can also return an [`Error::Json`] if there is an error deserializing
/// the API response.
///
/// [Kick Members]: Permissions::KICK_MEMBERS
pub async fn start_prune(&self, cache_http: impl CacheHttp, days: u16) -> Result<GuildPrune> {
#[cfg(feature = "cache")]
{
if cache_http.cache().is_some() {
let req = Permissions::KICK_MEMBERS;
if !self.has_perms(&cache_http, req).await {
return Err(Error::Model(ModelError::InvalidPermissions(req)));
}
}
}
self.id.start_prune(cache_http.http(), days).await
}
/// Unbans the given [`User`] from the guild.
///
/// **Note**: Requires the [Ban Members] permission.
///
/// # Errors
///
/// If the `cache` is enabled, returns a [`ModelError::InvalidPermissions`]
/// if the current user does not have permission to perform bans.
///
/// Otherwise will return an [`Error::Http`] if the current user does not
/// have permission.
///
/// [Ban Members]: Permissions::BAN_MEMBERS
pub async fn unban(
&self,
cache_http: impl CacheHttp,
user_id: impl Into<UserId>,
) -> Result<()> {
#[cfg(feature = "cache")]
{
if cache_http.cache().is_some() {
let req = Permissions::BAN_MEMBERS;
if !self.has_perms(&cache_http, req).await {
return Err(Error::Model(ModelError::InvalidPermissions(req)));
}
}
}
self.id.unban(&cache_http.http(), user_id).await
}
/// Retrieve's the guild's vanity URL.
///
/// **Note**: Requires the [Manage Guild] permission.
///
/// [Manage Guild]: Permissions::MANAGE_GUILD
///
/// # Errors
///
/// Will return [`Error::Http`] if the current user is lacking permissions.
/// Can also return an [`Error::Json`] if there is an error deserializing
/// the API response.
#[inline]
pub async fn vanity_url(&self, http: impl AsRef<Http>) -> Result<String> {
self.id.vanity_url(&http).await
}
/// Retrieves the guild's webhooks.
///
/// **Note**: Requires the [Manage Webhooks] permission.
///
/// [Manage Webhooks]: Permissions::MANAGE_WEBHOOKS
///
/// # Errors
///
/// Will return an [`Error::Http`] if the current user is lacking permissions.
/// Can also return an [`Error::Json`] if there is an error deserializing
/// the API response.
#[inline]
pub async fn webhooks(&self, http: impl AsRef<Http>) -> Result<Vec<Webhook>> {
self.id.webhooks(&http).await
}
/// Obtain a reference to a role by its name.
///
/// **Note**: If two or more roles have the same name, obtained reference will be one of
/// them.
///
/// # Examples
///
/// Obtain a reference to a [`Role`] by its name.
///
/// ```rust,no_run
/// # #[cfg(all(feature = "cache", feature = "client"))]
/// # async fn run() -> Result<(), Box<dyn std::error::Error>> {
/// use serenity::model::prelude::*;
/// use serenity::prelude::*;
///
/// struct Handler;
///
/// #[serenity::async_trait]
/// impl EventHandler for Handler {
/// async fn message(&self, ctx: Context, msg: Message) {
/// if let Some(guild_id) = msg.guild_id {
/// if let Some(guild) = guild_id.to_guild_cached(&ctx) {
/// if let Some(role) = guild.role_by_name("role_name") {
/// println!("{:?}", role);
/// }
/// }
/// }
/// }
/// }
///
/// let mut client =
/// Client::builder("token", GatewayIntents::default()).event_handler(Handler).await?;
///
/// client.start().await?;
/// # Ok(())
/// # }
/// ```
#[must_use]
pub fn role_by_name(&self, role_name: &str) -> Option<&Role> {
self.roles.values().find(|role| role_name == role.name)
}
/// Returns a future that will await one message sent in this guild.
#[cfg(feature = "collector")]
pub fn await_reply(&self, shard_messenger: impl AsRef<ShardMessenger>) -> CollectReply {
CollectReply::new(shard_messenger).guild_id(self.id.0)
}
/// Returns a stream builder which can be awaited to obtain a stream of messages in this guild.
#[cfg(feature = "collector")]
pub fn await_replies(
&self,
shard_messenger: impl AsRef<ShardMessenger>,
) -> MessageCollectorBuilder {
MessageCollectorBuilder::new(shard_messenger).guild_id(self.id.0)
}
/// Await a single reaction in this guild.
#[cfg(feature = "collector")]
pub fn await_reaction(&self, shard_messenger: impl AsRef<ShardMessenger>) -> CollectReaction {
CollectReaction::new(shard_messenger).guild_id(self.id.0)
}
/// Returns a stream builder which can be awaited to obtain a stream of reactions sent in this guild.
#[cfg(feature = "collector")]
pub fn await_reactions(
&self,
shard_messenger: impl AsRef<ShardMessenger>,
) -> ReactionCollectorBuilder {
ReactionCollectorBuilder::new(shard_messenger).guild_id(self.id.0)
}
/// Gets the guild active threads.
///
/// # Errors
///
/// Returns [`Error::Http`] if there is an error in the deserialization, or
/// if the bot issuing the request is not in the guild.
pub async fn get_active_threads(&self, http: impl AsRef<Http>) -> Result<ThreadsData> {
self.id.get_active_threads(http).await
}
}
impl<'de> Deserialize<'de> for Guild {
fn deserialize<D: Deserializer<'de>>(deserializer: D) -> StdResult<Self, D::Error> {
let mut map = JsonMap::deserialize(deserializer)?;
let id = map.get("id").and_then(Value::as_str).and_then(|x| x.parse::<u64>().ok());
if let Some(guild_id) = id {
if let Some(array) = map.get_mut("channels").and_then(Value::as_array_mut) {
for value in array {
if let Some(channel) = value.as_object_mut() {
channel.insert("guild_id".to_string(), from_number(guild_id));
}
}
}
if let Some(array) = map.get_mut("members").and_then(Value::as_array_mut) {
for value in array {
if let Some(member) = value.as_object_mut() {
member.insert("guild_id".to_string(), from_number(guild_id));
}
}
}
if let Some(array) = map.get_mut("roles").and_then(Value::as_array_mut) {
for value in array {
if let Some(role) = value.as_object_mut() {
role.insert("guild_id".to_string(), from_number(guild_id));
}
}
}
}
let afk_channel_id = match map.remove("afk_channel_id") {
Some(v) => from_value::<Option<ChannelId>>(v).map_err(DeError::custom)?,
None => None,
};
let afk_timeout = map
.remove("afk_timeout")
.ok_or_else(|| DeError::custom("expected guild afk_timeout"))
.and_then(u64::deserialize)
.map_err(DeError::custom)?;
let application_id = match map.remove("application_id") {
Some(v) => from_value::<Option<ApplicationId>>(v).map_err(DeError::custom)?,
None => None,
};
let channels = map
.remove("channels")
.ok_or_else(|| DeError::custom("expected guild channels"))
.and_then(deserialize_guild_channels)
.map_err(DeError::custom)?;
let default_message_notifications = map
.remove("default_message_notifications")
.ok_or_else(|| DeError::custom("expected guild default_message_notifications"))
.and_then(DefaultMessageNotificationLevel::deserialize)
.map_err(DeError::custom)?;
let emojis = map
.remove("emojis")
.ok_or_else(|| DeError::custom("expected guild emojis"))
.and_then(emojis::deserialize)
.map_err(DeError::custom)?;
let explicit_content_filter = map
.remove("explicit_content_filter")
.ok_or_else(|| DeError::custom("expected guild explicit_content_filter"))
.and_then(ExplicitContentFilter::deserialize)
.map_err(DeError::custom)?;
let features = map
.remove("features")
.ok_or(Error::Other("expected guild features"))
.and_then(from_value::<Vec<String>>)
.map_err(DeError::custom)?;
let icon = match map.remove("icon") {
Some(v) => Option::<String>::deserialize(v).map_err(DeError::custom)?,
None => None,
};
let id = map
.remove("id")
.ok_or_else(|| DeError::custom("expected guild id"))
.and_then(GuildId::deserialize)
.map_err(DeError::custom)?;
let joined_at = map
.remove("joined_at")
.ok_or_else(|| DeError::custom("expected guild joined_at"))
.and_then(Timestamp::deserialize)
.map_err(DeError::custom)?;
let large = map
.remove("large")
.ok_or_else(|| DeError::custom("expected guild large"))
.and_then(bool::deserialize)
.map_err(DeError::custom)?;
let member_count = map
.remove("member_count")
.ok_or_else(|| DeError::custom("expected guild member_count"))
.and_then(u64::deserialize)
.map_err(DeError::custom)?;
let members = map
.remove("members")
.ok_or_else(|| DeError::custom("expected guild members"))
.and_then(deserialize_members)
.map_err(DeError::custom)?;
let mfa_level = map
.remove("mfa_level")
.ok_or_else(|| DeError::custom("expected guild mfa_level"))
.and_then(MfaLevel::deserialize)
.map_err(DeError::custom)?;
let name = map
.remove("name")
.ok_or_else(|| DeError::custom("expected guild name"))
.and_then(String::deserialize)
.map_err(DeError::custom)?;
let owner_id = map
.remove("owner_id")
.ok_or_else(|| DeError::custom("expected guild owner_id"))
.and_then(UserId::deserialize)
.map_err(DeError::custom)?;
let presences = map
.remove("presences")
.ok_or_else(|| DeError::custom("expected guild presences"))
.and_then(presences::deserialize)
.map_err(DeError::custom)?;
let roles = map
.remove("roles")
.ok_or_else(|| DeError::custom("expected guild roles"))
.and_then(roles::deserialize)
.map_err(DeError::custom)?;
let splash = match map.remove("splash") {
Some(v) => Option::<String>::deserialize(v).map_err(DeError::custom)?,
None => None,
};
let system_channel_id = match map.remove("system_channel_id") {
Some(v) => Option::<ChannelId>::deserialize(v).map_err(DeError::custom)?,
None => None,
};
let verification_level = map
.remove("verification_level")
.ok_or_else(|| DeError::custom("expected guild verification_level"))
.and_then(VerificationLevel::deserialize)
.map_err(DeError::custom)?;
let voice_states = map
.remove("voice_states")
.ok_or_else(|| DeError::custom("expected guild voice_states"))
.and_then(deserialize_voice_states)
.map_err(DeError::custom)?;
let description = match map.remove("description") {
Some(v) => Option::<String>::deserialize(v).map_err(DeError::custom)?,
None => None,
};
let premium_tier = match map.remove("premium_tier") {
Some(v) => PremiumTier::deserialize(v).map_err(DeError::custom)?,
None => PremiumTier::default(),
};
let premium_subscription_count = match map.remove("premium_subscription_count") {
#[cfg(not(feature = "simd-json"))]
Some(Value::Null) | None => 0,
#[cfg(feature = "simd-json")]
Some(Value::Static(StaticNode::Null)) | None => 0,
Some(v) => u64::deserialize(v).map_err(DeError::custom)?,
};
let banner = match map.remove("banner") {
Some(v) => Option::<String>::deserialize(v).map_err(DeError::custom)?,
None => None,
};
let vanity_url_code = match map.remove("vanity_url_code") {
Some(v) => Option::<String>::deserialize(v).map_err(DeError::custom)?,
None => None,
};
let preferred_locale = map
.remove("preferred_locale")
.ok_or_else(|| DeError::custom("expected preferred locale"))
.and_then(String::deserialize)
.map_err(DeError::custom)?;
let welcome_screen = map
.remove("welcome_screen")
.map(GuildWelcomeScreen::deserialize)
.transpose()
.map_err(DeError::custom)?;
let approximate_member_count = map
.remove("approximate_member_count")
.map(u64::deserialize)
.transpose()
.map_err(DeError::custom)?;
let approximate_presence_count = map
.remove("approximate_presence_count")
.map(u64::deserialize)
.transpose()
.map_err(DeError::custom)?;
let max_video_channel_users = map
.remove("max_video_channel_users")
.map(u64::deserialize)
.transpose()
.map_err(DeError::custom)?;
let max_presences = match map.remove("max_presences") {
Some(v) => Option::<u64>::deserialize(v).map_err(DeError::custom)?,
None => None,
};
let max_members =
map.remove("max_members").map(u64::deserialize).transpose().map_err(DeError::custom)?;
let discovery_splash = match map.remove("discovery_splash") {
Some(v) => Option::<String>::deserialize(v).map_err(DeError::custom)?,
None => None,
};
let nsfw_level = map
.remove("nsfw_level")
.ok_or_else(|| DeError::custom("expected nsfw_level"))
.and_then(NsfwLevel::deserialize)
.map_err(DeError::custom)?;
let widget_enabled = match map.remove("widget_enabled") {
Some(v) => Option::<bool>::deserialize(v).map_err(DeError::custom)?,
None => None,
};
let widget_channel_id = match map.remove("widget_channel_id") {
Some(v) => Option::<ChannelId>::deserialize(v).map_err(DeError::custom)?,
None => None,
};
let rules_channel_id = match map.remove("rules_channel_id") {
Some(v) => Option::<ChannelId>::deserialize(v).map_err(DeError::custom)?,
None => None,
};
let public_updates_channel_id = match map.remove("public_updates_channel_id") {
Some(v) => Option::<ChannelId>::deserialize(v).map_err(DeError::custom)?,
None => None,
};
let system_channel_flags = map
.remove("system_channel_flags")
.ok_or_else(|| DeError::custom("expected system_channel_flags"))
.and_then(SystemChannelFlags::deserialize)
.map_err(DeError::custom)?;
let stage_instances = match map.remove("stage_instances") {
Some(v) => Vec::<StageInstance>::deserialize(v).map_err(DeError::custom)?,
None => Vec::new(),
};
let threads = match map.remove("threads") {
Some(v) => Vec::<GuildChannel>::deserialize(v).map_err(DeError::custom)?,
None => Vec::new(),
};
let stickers = map
.remove("stickers")
.ok_or_else(|| DeError::custom("expected guild stickers"))
.and_then(stickers::deserialize)
.map_err(DeError::custom)?;
Ok(Self {
afk_channel_id,
afk_timeout,
application_id,
channels,
default_message_notifications,
emojis,
explicit_content_filter,
features,
icon,
id,
joined_at,
large,
member_count,
members,
mfa_level,
name,
owner_id,
presences,
roles,
splash,
discovery_splash,
system_channel_id,
system_channel_flags,
rules_channel_id,
public_updates_channel_id,
verification_level,
voice_states,
description,
premium_tier,
premium_subscription_count,
banner,
vanity_url_code,
preferred_locale,
welcome_screen,
approximate_member_count,
approximate_presence_count,
nsfw_level,
max_video_channel_users,
max_presences,
max_members,
widget_enabled,
widget_channel_id,
stage_instances,
threads,
stickers,
})
}
}
/// Checks if a `&str` contains another `&str`.
#[cfg(feature = "model")]
fn contains_case_insensitive(to_look_at: &str, to_find: &str) -> bool {
to_look_at.to_lowercase().contains(&to_find.to_lowercase())
}
/// Checks if a `&str` starts with another `&str`.
#[cfg(feature = "model")]
fn starts_with_case_insensitive(to_look_at: &str, to_find: &str) -> bool {
to_look_at.to_lowercase().starts_with(&to_find.to_lowercase())
}
/// Takes a `&str` as `origin` and tests if either
/// `word_a` or `word_b` is closer.
///
/// **Note**: Normally `word_a` and `word_b` are
/// expected to contain `origin` as substring.
/// If not, using `closest_to_origin` would sort these
/// the end.
#[cfg(feature = "model")]
fn closest_to_origin(origin: &str, word_a: &str, word_b: &str) -> std::cmp::Ordering {
let value_a = match word_a.find(origin) {
Some(value) => value + word_a.len(),
None => return std::cmp::Ordering::Greater,
};
let value_b = match word_b.find(origin) {
Some(value) => value + word_b.len(),
None => return std::cmp::Ordering::Less,
};
value_a.cmp(&value_b)
}
/// A container for guilds.
///
/// This is used to differentiate whether a guild itself can be used or whether
/// a guild needs to be retrieved from the cache.
#[allow(clippy::large_enum_variant)]
#[derive(Clone, Debug)]
#[non_exhaustive]
pub enum GuildContainer {
/// A guild which can have its contents directly searched.
Guild(PartialGuild),
/// A guild's id, which can be used to search the cache for a guild.
Id(GuildId),
}
/// A [`Guild`] widget.
#[derive(Clone, Debug, Serialize, Deserialize)]
#[non_exhaustive]
pub struct GuildWidget {
/// Whether the widget is enabled.
pub enabled: bool,
/// The widget channel id.
pub channel_id: Option<ChannelId>,
}
/// Representation of the number of members that would be pruned by a guild
/// prune operation.
#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
pub struct GuildPrune {
/// The number of members that would be pruned by the operation.
pub pruned: u64,
}
/// Basic information about a guild.
#[derive(Clone, Debug, Deserialize, Serialize)]
pub struct GuildInfo {
/// The unique Id of the guild.
///
/// Can be used to calculate creation date.
pub id: GuildId,
/// The hash of the icon of the guild.
///
/// This can be used to generate a URL to the guild's icon image.
pub icon: Option<String>,
/// The name of the guild.
pub name: String,
/// Indicator of whether the current user is the owner.
pub owner: bool,
/// The permissions that the current user has.
pub permissions: Permissions,
}
#[cfg(any(feature = "model", feature = "utils"))]
impl GuildInfo {
/// Returns the formatted URL of the guild's icon, if the guild has an icon.
///
/// This will produce a WEBP image URL, or GIF if the guild has a GIF icon.
#[must_use]
pub fn icon_url(&self) -> Option<String> {
self.icon.as_ref().map(|icon| {
let ext = if icon.starts_with("a_") { "gif" } else { "webp" };
cdn!("/icons/{}/{}.{}", self.id, icon, ext)
})
}
}
impl From<PartialGuild> for GuildContainer {
fn from(guild: PartialGuild) -> GuildContainer {
GuildContainer::Guild(guild)
}
}
impl From<GuildId> for GuildContainer {
fn from(guild_id: GuildId) -> GuildContainer {
GuildContainer::Id(guild_id)
}
}
impl From<u64> for GuildContainer {
fn from(id: u64) -> GuildContainer {
GuildContainer::Id(GuildId(id))
}
}
#[cfg(feature = "model")]
impl InviteGuild {
/// Returns the formatted URL of the guild's splash image, if one exists.
#[must_use]
pub fn splash_url(&self) -> Option<String> {
self.splash.as_ref().map(|splash| cdn!("/splashes/{}/{}.webp?size=4096", self.id, splash))
}
}
/// Data for an unavailable guild.
#[derive(Clone, Copy, Debug, Deserialize, Serialize)]
pub struct UnavailableGuild {
/// The Id of the [`Guild`] that may be unavailable.
pub id: GuildId,
/// Indicator of whether the guild is unavailable.
#[serde(default)]
pub unavailable: bool,
}
/// Default message notification level for a guild.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
#[non_exhaustive]
pub enum DefaultMessageNotificationLevel {
/// Receive notifications for everything.
All = 0,
/// Receive only mentions.
Mentions = 1,
/// Unknown notification level.
Unknown = !0,
}
enum_number!(DefaultMessageNotificationLevel {
All,
Mentions
});
/// Setting used to filter explicit messages from members.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
#[non_exhaustive]
pub enum ExplicitContentFilter {
/// Don't scan any messages.
None = 0,
/// Scan messages from members without a role.
WithoutRole = 1,
/// Scan messages sent by all members.
All = 2,
/// Unknown content filter.
Unknown = !0,
}
enum_number!(ExplicitContentFilter {
None,
WithoutRole,
All
});
/// Multi-Factor Authentication level for guild moderators.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
#[non_exhaustive]
pub enum MfaLevel {
/// MFA is disabled.
None = 0,
/// MFA is enabled.
Elevated = 1,
/// Unknown MFA level.
Unknown = !0,
}
enum_number!(MfaLevel {
None,
Elevated
});
/// The level to set as criteria prior to a user being able to send
/// messages in a [`Guild`].
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
#[non_exhaustive]
pub enum VerificationLevel {
/// Does not require any verification.
None = 0,
/// Must have a verified email on the user's Discord account.
Low = 1,
/// Must also be a registered user on Discord for longer than 5 minutes.
Medium = 2,
/// Must also be a member of the guild for longer than 10 minutes.
High = 3,
/// Must have a verified phone on the user's Discord account.
Higher = 4,
/// Unknown verification level.
Unknown = !0,
}
enum_number!(VerificationLevel {
None,
Low,
Medium,
High,
Higher
});
/// The [`Guild`] nsfw level.
#[derive(Clone, Copy, Debug, Eq, Hash, PartialEq, PartialOrd, Ord)]
#[non_exhaustive]
pub enum NsfwLevel {
/// The nsfw level is not specified.
Default = 0,
/// The guild is considered as explicit.
Explicit = 1,
/// The guild is considered as safe.
Safe = 2,
/// The guild is age restricted.
AgeRestricted = 3,
/// Unknown nsfw level.
Unknown = !0,
}
enum_number!(NsfwLevel {
Default,
Explicit,
Safe,
AgeRestricted
});
#[cfg(test)]
mod test {
#[cfg(feature = "model")]
mod model {
use std::collections::*;
use crate::model::prelude::*;
fn gen_user() -> User {
User::default()
}
fn gen_member() -> Member {
let dt = Timestamp::now();
let vec1 = Vec::new();
let u = gen_user();
Member {
deaf: false,
guild_id: GuildId(1),
joined_at: Some(dt),
mute: false,
nick: Some("aaaa".to_string()),
roles: vec1,
user: u,
pending: false,
premium_since: None,
permissions: None,
avatar: None,
communication_disabled_until: None,
}
}
fn gen() -> Guild {
let u = gen_user();
let m = gen_member();
let hm1 = HashMap::new();
let hm2 = HashMap::new();
let vec1 = Vec::new();
let dt = Timestamp::now();
let mut hm3 = HashMap::new();
let hm4 = HashMap::new();
let hm5 = HashMap::new();
let hm6 = HashMap::new();
let hm7 = HashMap::new();
hm3.insert(u.id, m);
let notifications = DefaultMessageNotificationLevel::All;
Guild {
afk_channel_id: Some(ChannelId(0)),
afk_timeout: 0,
channels: hm1,
default_message_notifications: notifications,
emojis: hm2,
features: vec1,
icon: Some("/avatars/210/a_aaa.webp?size=1024".to_string()),
id: GuildId(1),
joined_at: dt,
large: false,
member_count: 1,
members: hm3,
mfa_level: MfaLevel::Elevated,
name: "Spaghetti".to_string(),
owner_id: UserId(210),
presences: hm4,
roles: hm5,
splash: Some("asdf".to_string()),
verification_level: VerificationLevel::None,
voice_states: hm6,
description: None,
premium_tier: PremiumTier::Tier1,
application_id: Some(ApplicationId(0)),
explicit_content_filter: ExplicitContentFilter::None,
system_channel_id: Some(ChannelId(0)),
system_channel_flags: SystemChannelFlags::default(),
rules_channel_id: None,
premium_subscription_count: 12,
banner: None,
vanity_url_code: Some("bruhmoment".to_string()),
preferred_locale: "en-US".to_string(),
welcome_screen: None,
approximate_member_count: None,
approximate_presence_count: None,
nsfw_level: NsfwLevel::Default,
max_video_channel_users: None,
max_presences: None,
max_members: None,
widget_enabled: Some(false),
discovery_splash: None,
widget_channel_id: None,
public_updates_channel_id: None,
stage_instances: vec![],
threads: vec![],
stickers: hm7,
}
}
#[test]
fn member_named_username() {
let guild = gen();
let lhs = guild.member_named("test#1432").unwrap().display_name();
assert_eq!(lhs, gen_member().display_name());
}
#[test]
fn member_named_nickname() {
let guild = gen();
let lhs = guild.member_named("aaaa").unwrap().display_name();
assert_eq!(lhs, gen_member().display_name());
}
}
}