Struct Credentials 

pub struct Credentials { /* private fields */ }

The application’s public key (required, verifies Interactions), and optionally the bot token (for Ctx::bot) and the application id (for a Bot Client outside Interactions).

Build it in code, from the conventional variables with from_lookup, or deserialize it: fields public_key, bot_token (or token), application_id.

use composure::Credentials;

let key = "a".repeat(64);
let credentials = Credentials::new(&key)?.with_bot_token("token");
assert_eq!(credentials.bot_token(), Some("token"));

// `config`: `settings.get::<Credentials>("discord")`, `envy`:
// `envy::prefixed("DISCORD_").from_env::<Credentials>()`, or any serde format
let credentials: Credentials = serde_json::from_str(&format!(
    r#"{{ "public_key": "{key}", "token": "token", "application_id": 123 }}"#
)).unwrap();
assert_eq!(credentials.application_id(), Some(123u64.into()));

Debug never shows the bot token.

Implementations

impl Credentials

pub fn new(public_key: &str) -> Result<Self, CredentialsError>

With the application’s public key (64 hex characters), no bot token or application id

pub fn from_lookup( lookup: impl FnMut(&str) -> Option<String>, ) -> Result<Self, CredentialsError>

From the conventional variables, lookup reading one by name: DISCORD_PUBLIC_KEY (required), DISCORD_TOKEN and DISCORD_APPLICATION_ID (optional). An empty value is unset.

let credentials = Credentials::from_lookup(|name| std::env::var(name).ok());

pub fn with_bot_token(self, token: impl Into<String>) -> Self

With the bot token, without the Bot prefix

pub fn with_application_id(self, id: Snowflake) -> Self

With the application id

pub fn public_key(&self) -> &str

The application’s public key, as hex

pub fn bot_token(&self) -> Option<&str>

The bot token, without the Bot prefix

pub fn application_id(&self) -> Option<Snowflake>

The application id

pub fn bot_client<T: Transport>(&self, transport: T) -> Option<BotClient<T>>

Available on crate feature rest only.

A Bot Client over transport, for REST outside Interactions; None without both a bot token and an application id

Trait Implementations

impl Clone for Credentials

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Credentials

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Credentials

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.