diff options
| author | Zeyla Hellyer <[email protected]> | 2017-05-23 10:15:26 -0700 |
|---|---|---|
| committer | Zeyla Hellyer <[email protected]> | 2017-05-23 10:15:26 -0700 |
| commit | 8c0aeacadb93d3b56fb98beb882eaef1f79cd652 (patch) | |
| tree | 7c1d26addbf15537c6f69a6ac9623276002b155a /src/builder/get_messages.rs | |
| parent | Fix {Invite,RichInvite}::url tests (diff) | |
| download | serenity-8c0aeacadb93d3b56fb98beb882eaef1f79cd652.tar.xz serenity-8c0aeacadb93d3b56fb98beb882eaef1f79cd652.zip | |
Add more examples and improve some others
Add examples to some functions, and update some of the old examples to
use the `?` operator instead of unwrapping.
Diffstat (limited to 'src/builder/get_messages.rs')
| -rw-r--r-- | src/builder/get_messages.rs | 32 |
1 files changed, 30 insertions, 2 deletions
diff --git a/src/builder/get_messages.rs b/src/builder/get_messages.rs index b9142a1..193adca 100644 --- a/src/builder/get_messages.rs +++ b/src/builder/get_messages.rs @@ -18,9 +18,37 @@ use ::model::MessageId; /// does not _need_ to be called and defaults to a value of 50. /// /// This should be used only for retrieving messages; see -/// [`Client::get_messages`] for examples. +/// [`GuildChannel::messages`] for examples. /// -/// [`Client::get_messages`]: ../client/struct.Client.html#method.get_messages +/// # Examples +/// +/// Creating a `GetMessages` builder to retrieve the first 25 messages after the +/// message with an Id of `158339864557912064`: +/// +/// ```rust,no_run +/// # use std::error::Error; +/// # +/// # fn try_main() -> Result<(), Box<Error>> { +/// use serenity::model::{ChannelId, MessageId}; +/// use serenity::builder::GetMessages; +/// +/// let retriever = GetMessages::default() +/// .after(MessageId(158339864557912064)) +/// .limit(25); +/// +/// // you can then pass it into a function which retrieves messages: +/// let channel_id = ChannelId(81384788765712384); +/// +/// let _messages = channel_id.messages(|_| retriever)?; +/// # Ok(()) +/// # } +/// # +/// # fn main() { +/// # try_main().unwrap(); +/// # } +/// ``` +/// +/// [`GuildChannel::messages`]: ../model/struct.GuildChannel.html#method.messages #[derive(Clone, Debug, Default)] pub struct GetMessages(pub BTreeMap<String, u64>); |