aboutsummaryrefslogtreecommitdiff
path: root/src/model/channel
diff options
context:
space:
mode:
authorZeyla Hellyer <[email protected]>2017-05-27 08:38:07 -0700
committerZeyla Hellyer <[email protected]>2017-05-27 08:38:07 -0700
commitc163d0e0f42a0a0f60060031bcf2a3d52e81a6eb (patch)
treee42f5cfb34018a540f5b4d3b354527f33479531e /src/model/channel
parentChange create_permission to take a reference (diff)
downloadserenity-c163d0e0f42a0a0f60060031bcf2a3d52e81a6eb.tar.xz
serenity-c163d0e0f42a0a0f60060031bcf2a3d52e81a6eb.zip
Fix GuildChannel::create_permission examples
The examples didn't bring `model::PermissionOverwriteType` into scope. Additionally, wrap the examples in try_main's to make use of the `?` operator.
Diffstat (limited to 'src/model/channel')
-rw-r--r--src/model/channel/guild_channel.rs60
1 files changed, 46 insertions, 14 deletions
diff --git a/src/model/channel/guild_channel.rs b/src/model/channel/guild_channel.rs
index f7cdce3..111dba2 100644
--- a/src/model/channel/guild_channel.rs
+++ b/src/model/channel/guild_channel.rs
@@ -122,13 +122,21 @@ impl GuildChannel {
/// permission, but denying the [Send TTS Messages] and [Attach Files]
/// permissions:
///
- /// ```rust,ignore
- /// use serenity::model::{ChannelId, PermissionOverwrite, permissions};
+ /// ```rust,no_run
+ /// # use serenity::model::{ChannelId, UserId};
+ /// # use std::error::Error;
+ /// #
+ /// # fn try_main() -> Result<(), Box<Error>> {
+ /// # let (channel_id, user_id) = (ChannelId(0), UserId(0));
+ /// #
+ /// use serenity::model::{
+ /// ModelError,
+ /// PermissionOverwrite,
+ /// PermissionOverwriteType,
+ /// permissions,
+ /// };
/// use serenity::CACHE;
///
- /// let channel_id = 7;
- /// let user_id = 8;
- ///
/// let allow = permissions::SEND_MESSAGES;
/// let deny = permissions::SEND_TTS_MESSAGES | permissions::ATTACH_FILES;
/// let overwrite = PermissionOverwrite {
@@ -138,9 +146,17 @@ impl GuildChannel {
/// };
///
/// let cache = CACHE.read().unwrap();
- /// let channel = cache.get_guild_channel(channel_id).unwrap();
+ /// let channel = cache
+ /// .guild_channel(channel_id)
+ /// .ok_or(ModelError::ItemMissing)?;
///
- /// let _ = channel.create_permission(overwrite);
+ /// channel.read().unwrap().create_permission(&overwrite)?;
+ /// # Ok(())
+ /// # }
+ /// #
+ /// # fn main() {
+ /// # try_main().unwrap();
+ /// # }
/// ```
///
/// Creating a permission overwrite for a role by specifying the
@@ -148,13 +164,21 @@ impl GuildChannel {
/// permission, but denying the [Send TTS Messages] and [Attach Files]
/// permissions:
///
- /// ```rust,ignore
- /// use serenity::model::{ChannelId, PermissionOverwrite, permissions};
+ /// ```rust,no_run
+ /// # use serenity::model::{ChannelId, UserId};
+ /// # use std::error::Error;
+ /// #
+ /// # fn try_main() -> Result<(), Box<Error>> {
+ /// # let (channel_id, user_id) = (ChannelId(0), UserId(0));
+ /// #
+ /// use serenity::model::{
+ /// ModelError,
+ /// PermissionOverwrite,
+ /// PermissionOverwriteType,
+ /// permissions,
+ /// };
/// use serenity::CACHE;
///
- /// let channel_id = 7;
- /// let user_id = 8;
- ///
/// let allow = permissions::SEND_MESSAGES;
/// let deny = permissions::SEND_TTS_MESSAGES | permissions::ATTACH_FILES;
/// let overwrite = PermissionOverwrite {
@@ -164,9 +188,17 @@ impl GuildChannel {
/// };
///
/// let cache = CACHE.read().unwrap();
- /// let channel = cache.get_guild_channel(channel_id).unwrap();
+ /// let channel = cache
+ /// .guild_channel(channel_id)
+ /// .ok_or(ModelError::ItemMissing)?;
///
- /// let _ = channel.create_permission(overwrite);
+ /// channel.read().unwrap().create_permission(&overwrite)?;
+ /// # Ok(())
+ /// # }
+ /// #
+ /// # fn main() {
+ /// # try_main().unwrap();
+ /// # }
/// ```
///
/// [`Channel`]: enum.Channel.html