Struct serenity::cache::Settings

pub struct Settings {
    pub max_messages: usize,
    // 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.

Methods

impl Settings

pub fn new() -> Self

Creates new settings to be used with a cache.

Important traits for &'a mut R

impl<'a, R> Read for &'a mut R where
    R: Read + ?Sized, impl<'a, W> Write for &'a mut W where
    W: Write + ?Sized, impl<'a, I> Iterator for &'a mut I where
    I: Iterator + ?Sized,  type Item = <I as Iterator>::Item;

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);

Trait Implementations

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.

impl Default for Settings

fn default() -> Settings

Returns the "default value" for a type.