Struct WebhooksCache 

pub struct WebhooksCache(/* private fields */);

Cache to hold webhooks, keyed by channel IDs for general usage

Implementations

impl WebhooksCache

pub fn new() -> Self

Creates a new webhook cache

Invalidation warning

Refer to the docs for WebhooksCache::update to avoid invalidation

pub async fn get_infallible( &self, http: &Client, channel_id: Id<ChannelMarker>, name: &str, ) -> Result<Ref<'_, Id<ChannelMarker>, Webhook>, Error>

Convenience function to get from the cache, requesting it from the API if it doesn’t exist, creating it if it’s also not returned

Required permissions

Make sure the bot has MANAGE_WEBHOOKS permission in the given channel

Errors

Returns an Error::Http or Error::Deserialize if the webhook isn’t in the cache

Panics

If the webhook that was just inserted to the cache somehow doesn’t exist

pub async fn create( &self, create_webhook: CreateWebhook<'_>, ) -> Result<(), Error>

Creates the passed webhook and caches it, it takes a CreateWebhook instead of a Webhook to reduce boilerplate and avoid clones

Errors

Returns Error::Http or Error::Deserialize

pub fn get( &self, channel_id: Id<ChannelMarker>, ) -> Option<Ref<'_, Id<ChannelMarker>, Webhook>>

Returns the webhook for the given channel_id, if it exists

pub async fn update( &self, event: &Event, http: &Client, permissions: PermissionsSource<'_>, ) -> Result<(), Error>

Removes the cached webhooks for the given event’s channel or guild

Unless the event is WebhookUpdate, this function isn’t actually async, http and permissions aren’t used, and it isn’t fallible

http is required because Discord doesn’t send info about updated webhooks in the event

permissions is required because the bot needs MANAGE_WEBHOOKS permissions to request webhooks

Invalidation warning

You should run this on ChannelDelete, GuildDelete and WebhookUpdate events to make sure deleted webhooks are removed from the cache, or else executing a cached webhook will return Unknown Webhook errors

Errors

Returns Error::Http, Error::Deserialize, or when [PermissionsSource::Cache] is passed, Error::CachePermissions

Trait Implementations

impl Debug for WebhooksCache

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for WebhooksCache

fn default() -> Self

Returns the “default value” for a type.