Struct redbot::Config

pub struct Config {
    pub username: String,
    pub password: String,
    pub user_agent: String,
    pub client_id: String,
    pub client_secret: String,
}

Program configuration - contains the required values to communicate with the Reddit OAuth API for a token.

The username and password fields are the same login strings that you'd use to log into the account on the Reddit website. The user_agent field is for setting the 'User Agent' header value to use when communicating with the API, as per the API usage requirements. The client_id and client_secret fields are for a 'script' type application that you create on the Reddit website.

Fields

username: String

Account username

password: String

Account password

user_agent: String

User agent to use

client_id: String

App client id

client_secret: String

App client secret

Methods

impl Config

pub fn load_config(path: &str) -> Result<Self, ApiError>

Attempt to load the configuration from a file.

Arguments

• path - relative path to the file

Examples

A file called 'config.json' is has the content:

{
  "username": "my-bot-account",
  "password": "hunter2",
  "user_agent": "linux:reddit-rust:v.0.0.1 (bot by /u/my-main-account)",
  "client_id": "foo",
  "client_secret": "bar"
}

Retrieve the config with:

let config = Config::load_config("config.json")?;

Trait Implementations

impl PartialEq<Config> for Config

fn eq(&self, other: &Config) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Config) -> bool

This method tests for !=.

impl Clone for Config

fn clone(&self) -> Config

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.