Struct irc::client::data::config::Config

pub struct Config {
    pub owners: Option<Vec<String>>,
    pub nickname: Option<String>,
    pub nick_password: Option<String>,
    pub alt_nicks: Option<Vec<String>>,
    pub username: Option<String>,
    pub realname: Option<String>,
    pub server: Option<String>,
    pub port: Option<u16>,
    pub password: Option<String>,
    pub use_ssl: Option<bool>,
    pub cert_path: Option<String>,
    pub encoding: Option<String>,
    pub channels: Option<Vec<String>>,
    pub umodes: Option<String>,
    pub user_info: Option<String>,
    pub version: Option<String>,
    pub source: Option<String>,
    pub ping_time: Option<u32>,
    pub ping_timeout: Option<u32>,
    pub burst_window_length: Option<u32>,
    pub max_messages_in_burst: Option<u32>,
    pub should_ghost: Option<bool>,
    pub ghost_sequence: Option<Vec<String>>,
    pub use_mock_connection: Option<bool>,
    pub mock_initial_value: Option<String>,
    pub channel_keys: Option<HashMap<String, String>>,
    pub options: Option<HashMap<String, String>>,
}

Configuration data.

Fields

owners: Option<Vec<String>>

A list of the owners of the client by nickname (for bots).

nickname: Option<String>

The client's nickname.

nick_password: Option<String>

The client's NICKSERV password.

alt_nicks: Option<Vec<String>>

Alternative nicknames for the client, if the default is taken.

username: Option<String>

The client's username.

realname: Option<String>

The client's real name.

server: Option<String>

The server to connect to.

port: Option<u16>

The port to connect on.

password: Option<String>

The password to connect to the server.

use_ssl: Option<bool>

Whether or not to use SSL. Clients will automatically panic if this is enabled without SSL support.

cert_path: Option<String>

The path to the SSL certificate for this server in DER format.

encoding: Option<String>

The encoding type used for this connection. This is typically UTF-8, but could be something else.

channels: Option<Vec<String>>

A list of channels to join on connection.

umodes: Option<String>

User modes to set on connect. Example: "+RB -x"

user_info: Option<String>

The text that'll be sent in response to CTCP USERINFO requests.

version: Option<String>

The text that'll be sent in response to CTCP VERSION requests.

source: Option<String>

The text that'll be sent in response to CTCP SOURCE requests.

ping_time: Option<u32>

The amount of inactivity in seconds before the client will ping the server.

ping_timeout: Option<u32>

The amount of time in seconds for a client to reconnect due to no ping response.

burst_window_length: Option<u32>

The length in seconds of a rolling window for message throttling. If more than max_messages_in_burst messages are sent within burst_window_length seconds, additional messages will be delayed automatically as appropriate. In particular, in the past burst_window_length seconds, there will never be more than max_messages_in_burst messages sent.

max_messages_in_burst: Option<u32>

The maximum number of messages that can be sent in a burst window before they'll be delayed. Messages are automatically delayed as appropriate.

should_ghost: Option<bool>

Whether the client should use NickServ GHOST to reclaim its primary nickname if it is in use. This has no effect if nick_password is not set.

ghost_sequence: Option<Vec<String>>

The command(s) that should be sent to NickServ to recover a nickname. The nickname and password will be appended in that order after the command. E.g. ["RECOVER", "RELEASE"] means RECOVER nick pass and RELEASE nick pass will be sent in that order.

use_mock_connection: Option<bool>

Whether or not to use a fake connection for testing purposes. You probably will never want to enable this, but it is used in unit testing for the irc crate.

mock_initial_value: Option<String>

The initial value used by the fake connection for testing. You probably will never need to set this, but it is used in unit testing for the irc crate.

channel_keys: Option<HashMap<String, String>>

A mapping of channel names to keys for join-on-connect.

options: Option<HashMap<String, String>>

A map of additional options to be stored in config.

Methods

impl Config

fn load<P: AsRef<Path>>(path: P) -> Result<Config>

Loads a configuration from the desired path. This will use the file extension to detect which format to parse the file as (json, toml, or yaml). Using each format requires having its respective crate feature enabled. Only json is available by default.

fn save<P: AsRef<Path>>(&self, path: P) -> Result<()>

Saves a configuration to the desired path. This will use the file extension to detect which format to parse the file as (json, toml, or yaml). Using each format requires having its respective crate feature enabled. Only json is available by default.

fn is_owner(&self, nickname: &str) -> bool

Determines whether or not the nickname provided is the owner of the bot.

fn nickname(&self) -> &str

Gets the nickname specified in the configuration. This will panic if not specified.

fn nick_password(&self) -> &str

Gets the bot's nickserv password specified in the configuration. This defaults to an empty string when not specified.

fn alternate_nicknames(&self) -> Vec<&str>

Gets the alternate nicknames specified in the configuration. This defaults to an empty vector when not specified.

fn username(&self) -> &str

Gets the username specified in the configuration. This defaults to the user's nickname when not specified.

fn real_name(&self) -> &str

Gets the real name specified in the configuration. This defaults to the user's nickname when not specified.

fn server(&self) -> &str

Gets the address of the server specified in the configuration. This panics when not specified.

fn port(&self) -> u16

Gets the port of the server specified in the configuration. This defaults to 6667 (or 6697 if use_ssl is specified as true) when not specified.

fn socket_addr(&self) -> Result<SocketAddr>

Gets the server and port as a SocketAddr. This panics when server is not specified or the address is malformed.

fn password(&self) -> &str

Gets the server password specified in the configuration. This defaults to a blank string when not specified.

fn use_ssl(&self) -> bool

Gets whether or not to use SSL with this connection. This defaults to false when not specified.

fn cert_path(&self) -> Option<&str>

Gets the path to the SSL certificate in DER format if specified.

fn encoding(&self) -> &str

Gets the encoding to use for this connection. This requires the encode feature to work. This defaults to UTF-8 when not specified.

fn channels(&self) -> Vec<&str>

Gets the channels to join upon connection. This defaults to an empty vector if it's not specified.

fn channel_key(&self, chan: &str) -> Option<&str>

Gets the key for the specified channel if it exists in the configuration.

fn umodes(&self) -> &str

Gets the user modes to set on connect specified in the configuration. This defaults to an empty string when not specified.

fn user_info(&self) -> &str

Gets the string to be sent in response to CTCP USERINFO requests. This defaults to an empty string when not specified.

fn version(&self) -> &str

Gets the string to be sent in response to CTCP VERSION requests. This defaults to irc:version:env when not specified. For example, irc:0.12.0:Compiled with rustc

fn source(&self) -> &str

Gets the string to be sent in response to CTCP SOURCE requests. This defaults to https://github.com/aatxe/irc when not specified.

fn ping_time(&self) -> u32

Gets the amount of time in seconds for the interval at which the client pings the server. This defaults to 180 seconds when not specified.

fn ping_timeout(&self) -> u32

Gets the amount of time in seconds for the client to disconnect after not receiving a ping response. This defaults to 10 seconds when not specified.

fn burst_window_length(&self) -> u32

The amount of time in seconds to consider a window for burst messages. The message throttling system maintains the invariant that in the past burst_window_length seconds, the maximum number of messages sent is max_messages_in_burst. This defaults to 8 seconds when not specified.

fn max_messages_in_burst(&self) -> u32

The maximum number of messages that can be sent in a burst window before they'll be delayed. Messages are automatically delayed until the start of the next window. The message throttling system maintains the invariant that in the past burst_window_length seconds, the maximum number of messages sent is max_messages_in_burst. This defaults to 15 messages when not specified.

fn should_ghost(&self) -> bool

Gets whether or not to attempt nickname reclamation using NickServ GHOST. This defaults to false when not specified.

fn ghost_sequence(&self) -> Vec<&str>

Gets the NickServ command sequence to recover a nickname. This defaults to ["GHOST"] when not specified.

fn get_option(&self, option: &str) -> &str

Looks up the specified string in the options map. This uses indexing, and thus panics when the string is not present. This will also panic if used and there are no options.

fn use_mock_connection(&self) -> bool

Gets whether or not to use a mock connection for testing. This defaults to false when not specified.

fn mock_initial_value(&self) -> &str

Gets the initial value for the mock connection. This defaults to false when not specified. This has no effect if use_mock_connection is not true.

Trait Implementations

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 Default for Config

fn default() -> Config

Returns the "default value" for a type.

impl PartialEq for Config

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

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

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

This method tests for !=.

impl Debug for Config

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

Formats the value using the given formatter.