aboutsummaryrefslogtreecommitdiff
path: root/examples/05_command_framework/src
diff options
context:
space:
mode:
authorZeyla Hellyer <[email protected]>2017-04-12 21:31:37 -0700
committerZeyla Hellyer <[email protected]>2017-04-12 21:31:37 -0700
commit1561f9e36384a215d2b866a752996f80d36a3ede (patch)
tree93d477139af1e96cdb4d167ed0ee67921c27a482 /examples/05_command_framework/src
parentFix `client::rest::delete_webhook_with_token` test (diff)
downloadserenity-1561f9e36384a215d2b866a752996f80d36a3ede.tar.xz
serenity-1561f9e36384a215d2b866a752996f80d36a3ede.zip
Add Shard Id helpers
Add helpers to retrieve the shard Id for guilds, and count how many guilds are handled by a Shard. Helpers to retrieve the shard Id of a guild have been added as: - `Guild::shard_id` - `GuildId::shard_id` These are in two forms: one working with the cache feature, and one without. The function that works with the cache will automatically retrieve the total number of shards from the Cache, while the uncached version requires passing in the total number of shards used. With the cache enabled, this might look like: ```rust guild.shard_id(); // which calls: guild_id.shard_id(); ``` Without the cache enabled, this looks like: ```rust let shard_count = 7; guild.shard_id(shard_count); // which calls: guild_id.shard_id(shard_count); ``` These two variants on `Guild` and `GuildId` are helper sugar methods over the new function `utils::shard_id`, which accepts a `guild_id` and a `shard_count`: ```rust use serenity::utils; assert_eq!(utils::shard_id(81384788765712384, 17), 7); ``` You would use `utils::shard_id` when you have the total number of shards due to `{Guild,GuildId}::shard_id` unlocking the cache to retrieve the total number of shards. This avoids some amount of work
Diffstat (limited to 'examples/05_command_framework/src')
0 files changed, 0 insertions, 0 deletions