Struct serenity::cache::Settings

pub struct Settings {
    pub max_messages: usize,
    pub cache_lock_time: Option<Duration>,
    // some fields omitted
}

Settings for the cache.

Examples

Create new settings, specifying the maximum number of messages:

use serenity::cache::Settings as CacheSettings;

let mut settings = CacheSettings::new();
settings.max_messages(10);

Fields

max_messages: usize

The maximum number of messages to store in a channel's message cache.

Defaults to 0.

cache_lock_time: Option<Duration>

The Duration cache updates will try to acquire write-locks for.

Defaults to 10 milliseconds.

Note: If set to None, cache updates will acquire write-lock until available, potentially deadlocking.

Methods

impl Settings

pub fn new() -> Self

Creates new settings to be used with a cache.

pub fn max_messages(&mut self, max: usize) -> &mut Self

Sets the maximum number of messages to cache in a channel.

Refer to max_messages for more information.

Examples

Set the maximum number of messages to cache:

use serenity::cache::Settings;

let mut settings = Settings::new();
settings.max_messages(10);

pub fn cache_lock_time(&mut self, duration: Option<Duration>) -> &mut Self

Sets the duration that the cache will try to aquire a write lock.

Refer to cache_lock_time for more information.

Note: Should be set before the client gets started, as it can not be changed after the first read of the duration.

Examples

Set the time that it will try to aquire a lock.

use std::time::Duration;
use std::env;
use serenity::prelude::*;

struct Handler;

impl EventHandler for Handler {}

fn main() {
    let token = env::var("DISCORD_TOKEN")
       .expect("Expected a token in the environment");
    serenity::CACHE
       .write().settings_mut()
       .cache_lock_time(Some(Duration::from_secs(1)));
    let mut client = Client::new(&token, Handler).unwrap();

    if let Err(why) = client.start() {
       println!("Client error: {:?}", why);
    }
}

Trait Implementations

impl Default for Settings

fn default() -> Self

Returns the "default value" for a type.

impl Clone for Settings

fn clone(&self) -> Settings

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Settings

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

Formats the value using the given formatter.