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
use serde::de::Error as DeError;
#[cfg(feature = "cache")]
use tracing::{error, warn};
#[cfg(feature = "model")]
use crate::builder::{
CreateApplicationCommand,
CreateApplicationCommandPermissionsData,
CreateApplicationCommands,
CreateApplicationCommandsPermissions,
CreateChannel,
CreateSticker,
EditAutoModRule,
EditGuild,
EditGuildWelcomeScreen,
EditGuildWidget,
EditMember,
EditRole,
EditSticker,
};
#[cfg(all(feature = "cache", feature = "utils", feature = "client"))]
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::http::{CacheHttp, Http};
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, roles, stickers};
/// Partial information about a [`Guild`]. This does not include information
/// like member data.
#[derive(Clone, Debug, Serialize)]
#[non_exhaustive]
pub struct PartialGuild {
/// Application ID of the guild creator if it is bot-created.
pub application_id: Option<ApplicationId>,
/// 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,
/// 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,
/// Indicator of whether notifications for all messages are enabled by
/// default in the guild.
pub default_message_notifications: DefaultMessageNotificationLevel,
/// 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>,
/// All of the guild's custom emojis.
#[serde(with = "emojis")]
pub emojis: HashMap<EmojiId, Emoji>,
/// Features enabled for the guild.
///
/// Refer to [`Guild::features`] for more information.
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>,
/// 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,
/// Whether or not the user is the owner of the guild.
#[serde(default)]
pub owner: bool,
/// A mapping of the guild's roles.
#[serde(with = "roles")]
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,
/// The guild'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.
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 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>,
/// The user permissions in the guild.
pub permissions: Option<String>,
/// All of the guild's custom stickers.
#[serde(with = "stickers")]
pub stickers: HashMap<StickerId, Sticker>,
}
#[cfg(feature = "model")]
impl PartialGuild {
/// Gets all auto moderation [`Rule`]s of this guild via HTTP.
///
/// **Note**: Requires the [Manage Guild] permission.
///
/// # Errors
///
/// Returns [`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 [`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};
///
/// 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
}
/// Ban a [`User`] from the guild, deleting a number of
/// days' worth of messages (`dmd`) between the range 0 and 7.
///
/// **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.
///
/// Also may return [`Error::Http`] if the current user lacks permission.
///
/// [Ban Members]: Permissions::BAN_MEMBERS
#[inline]
pub async fn ban(
&self,
http: impl AsRef<Http>,
user: impl Into<UserId>,
dmd: u8,
) -> Result<()> {
self.ban_with_reason(&http, user, dmd, "").await
}
/// Ban a [`User`] from the guild with a reason. Refer to [`Self::ban`] to further documentation.
///
/// # Errors
///
/// In addition to the reasons [`Self::ban`] may return an error,
/// can also return an error if the reason is too long.
#[inline]
pub async fn ban_with_reason(
&self,
http: impl AsRef<Http>,
user: impl Into<UserId>,
dmd: u8,
reason: impl AsRef<str>,
) -> Result<()> {
self.id.ban_with_reason(&http, user, dmd, reason).await
}
/// Gets a list of the guild's bans.
///
/// Requires the [Ban Members] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission.
///
/// [Ban Members]: Permissions::BAN_MEMBERS
#[inline]
pub async fn bans(&self, http: impl AsRef<Http>) -> Result<Vec<Ban>> {
self.id.bans(&http).await
}
/// Gets a list of the guild's audit log entries
///
/// **Note**: Requires the [View Audit Log] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission,
/// 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 current user is not in
/// the guild or if the guild is otherwise unavailable.
#[inline]
pub async fn channels(
&self,
http: impl AsRef<Http>,
) -> Result<HashMap<ChannelId, GuildChannel>> {
self.id.channels(&http).await
}
#[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
}
/// Creates a [`GuildChannel`] in the guild.
///
/// Refer to [`Http::create_channel`] for more information.
///
/// Requires the [Manage Channels] permission.
///
/// # Examples
///
/// Create a voice channel in a guild with the name `test`:
///
/// ```rust,ignore
/// use serenity::model::ChannelType;
///
/// guild.create_channel(|c| c.name("test").kind(ChannelType::Voice));
/// ```
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission,
/// or if invalid data was given, such as the channel name being
/// too long.
///
/// [Manage Channels]: Permissions::MANAGE_CHANNELS
#[inline]
pub async fn create_channel(
&self,
http: impl AsRef<Http>,
f: impl FnOnce(&mut CreateChannel) -> &mut CreateChannel,
) -> Result<GuildChannel> {
self.id.create_channel(&http, f).await
}
/// Creates an emoji in the guild with a name and base64-encoded image.
///
/// Refer to the documentation for [`Guild::create_emoji`] for more
/// information.
///
/// 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,
/// if the emoji name is too long, or if the image is too large.
///
/// [`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(
&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
}
/// Same as [`create_application_command_permission`] but allows to create
/// more than one permission per call.
///
/// [`create_application_command_permission`]: Self::create_application_command_permission
///
/// # 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.
///
/// See the documentation for [`Guild::create_role`] on how to use this.
///
/// **Note**: Requires the [Manage Roles] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission,
/// or if an invalid value was set.
///
/// [Manage Roles]: Permissions::MANAGE_ROLES
#[inline]
pub async fn create_role<F>(&self, http: impl AsRef<Http>, f: F) -> Result<Role>
where
F: FnOnce(&mut EditRole) -> &mut EditRole,
{
self.id.create_role(&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
///
/// Returns [`Error::Http`] if the current user is not the owner of
/// the guild.
#[inline]
pub async fn delete(&self, http: impl AsRef<Http>) -> Result<PartialGuild> {
self.id.delete(&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,
/// or if an emoji with that Id does not exist in the guild.
///
/// [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 [`Error::Http`] if the current user lacks permission,
/// or if an integration with that Id does not exist in the guild.
///
/// [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,
/// or if a Role with that Id does not exist in the Guild.
///
/// [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 [`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.
///
/// **Note**: Requires the current user to have the [Manage Guild]
/// permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if an invalid value is set, or if the current user
/// lacks permission to edit the guild.
///
/// [Manage Guild]: Permissions::MANAGE_GUILD
pub async fn edit<F>(&mut self, http: impl AsRef<Http>, f: F) -> Result<()>
where
F: FnOnce(&mut EditGuild) -> &mut EditGuild,
{
match self.id.edit(&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 `methods` features
/// enabled.
///
/// Requires the [Manage Emojis and Stickers] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission,
/// or if an emoji with that Id does not exist in the guild.
///
/// [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.
///
/// 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
/// use serenity::model::GuildId;
///
/// GuildId(7).edit_member(user_id, |m| m.mute(true).roles(&vec![role_id])).await;
/// ```
///
/// # 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
///
/// Returns [`Error::Http`] if the current user lacks permission
/// to change their nickname.
///
/// [Change Nickname]: Permissions::CHANGE_NICKNAME
#[inline]
pub async fn edit_nickname(
&self,
http: impl AsRef<Http>,
new_nickname: Option<&str>,
) -> Result<()> {
self.id.edit_nickname(&http, new_nickname).await
}
/// Edits a role, optionally setting its fields.
///
/// Requires the [Manage Roles] permission.
///
/// # Examples
///
/// Make a role hoisted:
///
/// ```rust,ignore
/// partial_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;
/// partial_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
}
/// 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.
///
/// # Errors
///
/// Returns [`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 async 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()).await
}
#[cfg(feature = "cache")]
async 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 = cache
.as_ref()
.guild(self.id)?
.members
.get(&lhs_id)?
.highest_role_info(&cache)
.unwrap_or((RoleId(0), 0));
let rhs = cache
.as_ref()
.guild(self.id)?
.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)
}
}
/// 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 everyone = if let Some(everyone) = self.roles.get(&RoleId(self.id.0)) {
everyone
} else {
error!("@everyone role ({}) missing in '{}'", self.id, self.name,);
return Ok(Permissions::empty());
};
let member = self.member(cache_http, &user_id).await?;
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 Ok(Permissions::all());
}
permissions |= role.permissions;
} else {
warn!("{} on {} has non-existent role {:?}", member.user.id, self.id, role,);
}
}
Ok(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
}
/// 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
}
#[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
}
}
/// 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,
/// can 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
}
/// Returns a formatted URL of the guild's icon, if the guild has an icon.
#[must_use]
pub fn icon_url(&self) -> Option<String> {
self.icon.as_ref().map(|icon| cdn!("/icons/{}/{}.webp", self.id, icon))
}
/// Returns a formatted URL of the guild's banner, if the guild has a banner.
#[must_use]
pub fn banner_url(&self) -> Option<String> {
self.banner.as_ref().map(|banner| cdn!("/banners/{}/{}.webp", self.id, banner))
}
/// 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 [`Error::Http`] if an [`Emoji`] with the given Id does
/// not exist for the guild.
#[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.
///
/// Requires the [Manage Guild] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission.
///
/// [Manage Guild]: Permissions::MANAGE_GUILD
#[inline]
pub async fn integrations(&self, http: impl AsRef<Http>) -> Result<Vec<Integration>> {
self.id.integrations(&http).await
}
/// Gets all of the guild's invites.
///
/// Requires the [Manage Guild] permission.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission.
///
/// [Manage Guild]: Permissions::MANAGE_GUILD
#[inline]
pub async fn invites(&self, http: impl AsRef<Http>) -> Result<Vec<RichInvite>> {
self.id.invites(&http).await
}
/// Leaves the guild.
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user is unable to
/// 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 [`Error::Http`] if the member 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
}
/// 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> {
Guild::_user_permissions_in(channel, member, &self.roles, self.owner_id, self.id)
}
/// Calculate a [`Role`]'s permissions in a given channel in the guild.
///
/// # Errors
///
/// Returns [`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> {
Guild::_role_permissions_in(channel, role, self.id)
}
/// Gets the number of [`Member`]s that would be pruned with the given
/// number of days.
///
/// Requires the [Kick Members] permission.
///
/// See [`Guild::prune_count`].
///
/// # Errors
///
/// Returns [`Error::Http`] if the current user lacks permission.
///
/// [Kick Members]: Permissions::KICK_MEMBERS
/// [`Guild::prune_count`]: crate::model::guild::Guild::prune_count
#[inline]
pub async fn prune_count(&self, http: impl AsRef<Http>, days: u16) -> Result<GuildPrune> {
self.id.prune_count(&http, days).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]
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.
#[inline]
#[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
///
/// See [`Guild::start_integration_sync`].
///
/// [Manage Guild]: Permissions::MANAGE_GUILD
/// [`Guild::start_integration_sync`]: crate::model::guild::Guild::start_integration_sync
#[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
}
/// Unbans a [`User`] from the guild.
///
/// Requires the [Ban Members] permission.
///
/// # Errors
///
/// See [`Guild::unban`].
///
/// [Ban Members]: Permissions::BAN_MEMBERS
/// [`Guild::unban`]: crate::model::guild::Guild::unban
#[inline]
pub async fn unban(&self, http: impl AsRef<Http>, user_id: impl Into<UserId>) -> Result<()> {
self.id.unban(&http, user_id).await
}
/// Retrieve's the guild's vanity URL.
///
/// **Note**: Requires the [Manage Guild] permission.
///
/// # Errors
///
/// See [`Guild::vanity_url`].
///
/// [Manage Guild]: Permissions::MANAGE_GUILD
/// [`Guild::vanity_url`]: crate::model::guild::Guild::vanity_url
#[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.
///
/// # Errors
///
/// See [`Guild::webhooks`].
///
/// [Manage Webhooks]: Permissions::MANAGE_WEBHOOKS
/// [`Guild::webhooks`]: crate::model::guild::Guild::webhooks
#[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 = "client", feature = "cache"))]
/// # 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, context: Context, msg: Message) {
/// if let Some(guild_id) = msg.guild_id {
/// if let Some(guild) = guild_id.to_guild_cached(&context) {
/// if let Some(role) = guild.role_by_name("role_name") {
/// println!("Obtained role's reference: {:?}", role);
/// }
/// }
/// }
/// }
/// }
///
/// let mut client =
/// Client::builder("token", GatewayIntents::default()).event_handler(Handler).await?;
///
/// client.start().await?;
/// # Ok(())
/// # }
/// ```
#[inline]
#[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 PartialGuild {
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("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 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 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 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 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 verification_level = map
.remove("verification_level")
.ok_or_else(|| DeError::custom("expected guild verification_level"))
.and_then(VerificationLevel::deserialize)
.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 system_channel_id = match map.remove("system_channel_id") {
Some(v) => Option::<ChannelId>::deserialize(v).map_err(DeError::custom)?,
None => None,
};
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 owner = map
.remove("owner")
.map(bool::deserialize)
.transpose()
.map_err(DeError::custom)?
.unwrap_or_default();
let nsfw_level = map
.remove("nsfw_level")
.ok_or_else(|| DeError::custom("expected nsfw_level"))
.and_then(NsfwLevel::deserialize)
.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 application_id = match map.remove("application_id") {
Some(v) => Option::<ApplicationId>::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 rules_channel_id = match map.remove("rules_channel_id") {
Some(v) => Option::<ChannelId>::deserialize(v).map_err(DeError::custom)?,
None => None,
};
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 permissions = match map.remove("permissions") {
Some(v) => Option::<String>::deserialize(v).map_err(DeError::custom)?,
None => None,
};
let welcome_screen = map
.remove("welcome_screen")
.map(GuildWelcomeScreen::deserialize)
.transpose()
.map_err(DeError::custom)?;
let stickers = map
.remove("stickers")
.ok_or_else(|| DeError::custom("expected guild stickers"))
.and_then(stickers::deserialize)
.map_err(DeError::custom)?;
Ok(Self {
application_id,
id,
afk_channel_id,
afk_timeout,
default_message_notifications,
widget_enabled,
widget_channel_id,
emojis,
features,
icon,
mfa_level,
name,
owner_id,
owner,
roles,
splash,
discovery_splash,
system_channel_id,
system_channel_flags,
rules_channel_id,
public_updates_channel_id,
verification_level,
description,
premium_tier,
premium_subscription_count,
banner,
vanity_url_code,
welcome_screen,
approximate_member_count,
approximate_presence_count,
nsfw_level,
max_video_channel_users,
max_presences,
max_members,
permissions,
stickers,
})
}
}
impl From<Guild> for PartialGuild {
/// Converts this [`Guild`] instance into a [`PartialGuild`]
///
/// [`PartialGuild`] is not a strict subset and contains some data specific to the current user
/// that [`Guild`] does not contain. Therefore, this method needs access to cache and HTTP to
/// generate the missing data
fn from(guild: Guild) -> Self {
Self {
application_id: guild.application_id,
id: guild.id,
afk_channel_id: guild.afk_channel_id,
afk_timeout: guild.afk_timeout,
default_message_notifications: guild.default_message_notifications,
widget_enabled: guild.widget_enabled,
widget_channel_id: guild.widget_channel_id,
emojis: guild.emojis,
features: guild.features,
icon: guild.icon,
mfa_level: guild.mfa_level,
name: guild.name,
owner_id: guild.owner_id,
// Not very good, but PartialGuild deserialization uses .unwrap_or_default() too
owner: Default::default(),
roles: guild.roles,
splash: guild.splash,
discovery_splash: guild.discovery_splash,
system_channel_id: guild.system_channel_id,
system_channel_flags: guild.system_channel_flags,
rules_channel_id: guild.rules_channel_id,
public_updates_channel_id: guild.public_updates_channel_id,
verification_level: guild.verification_level,
description: guild.description,
premium_tier: guild.premium_tier,
premium_subscription_count: guild.premium_subscription_count,
banner: guild.banner,
vanity_url_code: guild.vanity_url_code,
welcome_screen: guild.welcome_screen,
approximate_member_count: guild.approximate_member_count,
approximate_presence_count: guild.approximate_presence_count,
nsfw_level: guild.nsfw_level,
max_video_channel_users: guild.max_video_channel_users,
max_presences: guild.max_presences,
max_members: guild.max_members,
permissions: None,
stickers: guild.stickers,
}
}
}