Module serenity::prelude[][src]

A set of exports which can be helpful to use.

Note that the SerenityError re-export is equivalent to serenity::Error, although is re-exported as a separate name to remove likely ambiguity with other crate error enums.

Examples

Import all of the exports:

use serenity::prelude::*;

Re-exports

pub use model::misc::Mentionable;
pub use client::Client;
pub use model::ModelError;

Structs

Context

The context is a general utility struct provided on event dispatches, which helps with dealing with the current "context" of the event dispatch. The context also acts as a general high-level interface over the associated Shard which received the event, or the low-level http module.

Mutex

A mutual exclusion primitive useful for protecting shared data

RwLock

A reader-writer lock

Enums

ClientError

An error returned from the Client.

GatewayError

An error that occurred while attempting to deal with the gateway.

HttpError
SerenityError

A common error enum returned by most of the library's functionality within a custom Result.

VoiceError

An error returned from the voice module.

Traits

EventHandler

The core trait for handling events by serenity.