Struct Config

pub struct Config { /* private fields */ }

Config for the IRC client
For more information about what arguments the IRC commands take, see commands::Command.

Implementations

impl Config

pub fn new( channels: &[&'static str], host: &str, mode: Option<&'static str>, nickname: Option<&'static str>, port: u16, username: &str, ) -> Self

Create a new config for the client

Example

let config = Config::new(
    &["#chaos", "#async-circe"],
    "karx.xyz",
    Some("+B"),
    Some("async-circe"),
    6697,
    "circe",
);

pub fn runtime_config( channels: Vec<String>, host: String, mode: Option<String>, nickname: Option<String>, port: u16, username: String, ) -> Self

Allows for configuring async-circe at runtime.

Example

# use async_circe::Config;
let config = Config::runtime_config(
    vec!["#chaos".to_string(), "#async-circe".to_string()],
    "karx.xyz".to_string(),
    Some("+B".to_string()),
    Some("async-circe".to_string()),
    6697,
    "circe".to_string(),
);

pub fn from_toml<P: AsRef<Path>>(path: P) -> Result<Self, Error>

Available on crate feature toml_config only.

Create a config from a toml file

Example

#Config.toml
channels = ["#chaos", "#async-circe"]
host = "karx.xyz"
mode = "+B"
nickname = "async-circe"
port = 6667
username = "circe"

let config = Config::from_toml("Config.toml")?;

Errors

Returns an Error if the file cannot be opened or if the TOML is invalid

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate 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 Default for Config

fn default() -> Config

Returns the “default value” for a type.

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.