Crate smalld

SmallD aims to be a minmalist client for the Discord API. It aims to let you use the Discord API, without hiding or abstracting it.

SmallD takes care of the essentials of interacting with the Discord API, providing a small and flexible core to be built upon. As it does not aim to hide the Discord API working with SmallD will also require an understanding of Discord's API. As such it's usually helpful to keep the Discord Dev Docs in mind.

An example of what's in scope for SmallD:

• Authentication (Identifying/Resuming)
• Rate limiting
• Handling disconnections/reconnects

Examples of what is not in scope for SmallD:

• Caching
• Command Framework

Getting Started

After you have created a new project add smalld_rust as a dependency.

[dependencies]
smalld_rust = "*"

To use SmallD create a SmallD instance and call run to connect to Discord.

use smalld::SmallD;

let smalld = SmallD::new().expect("Failed to initialize smalld");

// this will block and run until a fatal error or smalld.close() is called
smalld.run();

By default this will look for your Discord token in the SMALLD_TOKEN environment variable. It's possible to explicitly provide the token and other configuration options when using SmallDBuilder.

use smalld::{Intent, SmallDBuilder};

let smalld = SmallDBuilder::new()
  .token("my_discord_token")
  .intents(Intent::GuildMessages | Intent::DirectMessages)
  .build()
  .expect("Failed to initialize smalld");

smalld.run();

To listen to events from Discord use the on_event method, or for all gateway payloads use on_gateway_payload, and attach a listener. Each listener receives a reference to SmallD and the json Value associated with that event.

use smalld::SmallD;

let smalld = SmallD::new().expect("Failed to initialize smalld");

smalld.on_event("MESSAGE_CREATE", |smalld, json| {
  if let Some("ping") = json.get("content").and_then(|c| c.as_str()) {
    println!("Ping Received!");
  }
});

smalld.run();

To send requests through Discord's resources api SmallD provides methods related to the HTTP methods. For example, post for sending a HTTP post request. We can use this method to send a request to the create message endpoint.

For example, we could add the following method to send a pong response for the above example.

pub fn send_pong(smalld: &SmallD, reply_to: Value) -> Result<(), Error> {
  if let Some(channel_id) = reply_to.get("channel_id").and_then(|c| c.as_str()) {
    smalld.post(
        format!("/channels/{}/msesages", channel_id),
        json!({"content" : "pong"}))?;
  };

  Ok(())
}

Structs

Payload	Struct representing payloads received from the Discord gateway.
QueryParameters
SmallD	SmallD is the central point for access to the Discord API.
SmallDBuilder	Builder to configure and create a SmallD.

Enums

Error	Error type for errors occurring in the use of SmallD.
Intent	Gateway intent to be requested upon identifying with Discord. Configure via intents.
Op	Opcode as will be received in a Payload received from Discord.