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

source ·

pub struct Config {Show 30 fields
    pub owners: Vec<String>,
    pub nickname: Option<String>,
    pub nick_password: Option<String>,
    pub alt_nicks: Vec<String>,
    pub username: Option<String>,
    pub realname: Option<String>,
    pub server: Option<String>,
    pub port: Option<u16>,
    pub password: Option<String>,
    pub use_tls: Option<bool>,
    pub cert_path: Option<String>,
    pub client_cert_path: Option<String>,
    pub client_cert_pass: Option<String>,
    pub dangerously_accept_invalid_certs: Option<bool>,
    pub encoding: Option<String>,
    pub channels: 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: bool,
    pub ghost_sequence: Option<Vec<String>>,
    pub use_mock_connection: bool,
    pub mock_initial_value: Option<String>,
    pub channel_keys: HashMap<String, String>,
    pub options: HashMap<String, String>,
    /* private fields */
}

Expand description

Configuration for IRC clients.

§Building a configuration programmatically

For some use cases, it may be useful to build configurations programmatically. Since Config is an ordinary struct with public fields, this should be rather straightforward. However, it is important to note that the use of Config::default() is important, even when specifying all visible fields because Config keeps track of whether it was loaded from a file or programmatically defined, in order to produce better error messages. Using Config::default() as below will ensure that this process is handled correctly.

use irc::client::prelude::Config;

let config = Config {
    nickname: Some("test".to_owned()),
    server: Some("irc.example.com".to_owned()),
    ..Config::default()
};

§Loading a configuration from a file

The standard method of using a configuration is to load it from a TOML file. You can find an example TOML configuration in the README, as well as a minimal example with code for loading the configuration below.

§TOML (`config.toml`)

nickname = "test"
server = "irc.example.com"

§Rust

use irc::client::prelude::Config;

let config = Config::load("config.toml").unwrap();

Fields§

§owners: 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: 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_tls: Option<bool>

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

§cert_path: Option<String>

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

§client_cert_path: Option<String>

The path to a TLS certificate to use for CertFP client authentication in a DER-formatted PKCS #12 archive.

§client_cert_pass: Option<String>

The password for the certificate to use in CertFP authentication.

§dangerously_accept_invalid_certs: Option<bool>

On true, all certificate validations are skipped. Defaults to false.

§Warning

You should think very carefully before using this method. If invalid hostnames are trusted, any valid certificate for any site will be trusted for use. This introduces significant vulnerabilities, and should only be used as a last resort.

§encoding: Option<String>

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

§channels: 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: 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: 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: HashMap<String, String>

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

§options: HashMap<String, String>

A map of additional options to be stored in config.

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

§Building a configuration programmatically

§Loading a configuration from a file

§TOML (config.toml)

§Rust

Fields§

§Warning

Implementations§

impl Config

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

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

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

pub fn nickname(&self) -> Result<&str>

pub fn nick_password(&self) -> &str

pub fn alternate_nicknames(&self) -> &[String]

pub fn username(&self) -> &str

pub fn real_name(&self) -> &str

pub fn server(&self) -> Result<&str>

pub fn port(&self) -> u16

pub fn password(&self) -> &str

pub fn use_tls(&self) -> bool

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

pub fn dangerously_accept_invalid_certs(&self) -> bool

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

pub fn client_cert_pass(&self) -> &str

pub fn encoding(&self) -> &str

pub fn channels(&self) -> &[String]

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

pub fn umodes(&self) -> &str

pub fn user_info(&self) -> &str

pub fn version(&self) -> &str

pub fn source(&self) -> &str

pub fn ping_time(&self) -> u32

pub fn ping_timeout(&self) -> u32

pub fn burst_window_length(&self) -> u32

pub fn max_messages_in_burst(&self) -> u32

pub fn should_ghost(&self) -> bool

pub fn ghost_sequence(&self) -> Option<&[String]>

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

pub fn use_mock_connection(&self) -> bool

pub fn mock_initial_value(&self) -> &str

Trait Implementations§

impl Clone for Config

fn clone(&self) -> Config

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

impl Debug for Config

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

impl Default for Config

fn default() -> Config

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

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

impl PartialEq for Config

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

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

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

impl StructuralPartialEq for Config

Auto Trait Implementations§

impl Freeze for Config

impl RefUnwindSafe for Config

impl Send for Config

impl Sync for Config

impl Unpin for Config

impl UnwindSafe for Config

Blanket Implementations§

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<T> From<T> for T

fn from(t: T) -> T

impl<T> Instrument for T

fn instrument(self, span: Span) -> Instrumented<Self>

fn in_current_span(self) -> Instrumented<Self>

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

§TOML (`config.toml`)

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

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>
where S: Serializer,

impl<T> Any for T
where T: 'static + ?Sized,

impl<T> Borrow<T> for T
where T: ?Sized,

impl<T> BorrowMut<T> for T
where T: ?Sized,

impl<T, U> Into<U> for T
where U: From<T>,

impl<T> ToOwned for T
where T: Clone,

impl<T, U> TryFrom<U> for T
where U: Into<T>,

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,