Struct ConfigBuilder

pub struct ConfigBuilder { /* private fields */ }

Config Builder

Implementations

impl ConfigBuilder

pub fn new() -> Self

Create a builder with a default config, equivalent to ConfigBuilder::default()

Examples found in repository

examples/tor.rs (line 9)

fn main() {
    // NOTE: This assumes Tor is running localy, with an unauthenticated Socks5 listening at
    // localhost:9050
    let proxy = Socks5Config::new("127.0.0.1:9050");
    let config = ConfigBuilder::new().socks5(Some(proxy)).build();

    let client = Client::from_config("tcp://explorernuoc63nb.onion:110", config.clone()).unwrap();
    let res = client.server_features();
    println!("{:#?}", res);

    // works both with onion v2/v3 (if your Tor supports them)
    let client = Client::from_config(
        "tcp://explorerzydxu5ecjrkwceayqybizmpjjznk5izmitf2modhcusuqlid.onion:110",
        config,
    )
    .unwrap();
    let res = client.server_features();
    println!("{:#?}", res);
}

pub fn socks5(self, socks5_config: Option<Socks5Config>) -> Self

Set the socks5 config if Some, it accept an Option because it’s easier for the caller to use in a method chain

Examples found in repository

examples/tor.rs (line 9)

fn main() {
    // NOTE: This assumes Tor is running localy, with an unauthenticated Socks5 listening at
    // localhost:9050
    let proxy = Socks5Config::new("127.0.0.1:9050");
    let config = ConfigBuilder::new().socks5(Some(proxy)).build();

    let client = Client::from_config("tcp://explorernuoc63nb.onion:110", config.clone()).unwrap();
    let res = client.server_features();
    println!("{:#?}", res);

    // works both with onion v2/v3 (if your Tor supports them)
    let client = Client::from_config(
        "tcp://explorerzydxu5ecjrkwceayqybizmpjjznk5izmitf2modhcusuqlid.onion:110",
        config,
    )
    .unwrap();
    let res = client.server_features();
    println!("{:#?}", res);
}

pub fn timeout(self, timeout: Option<u8>) -> Self

Sets the timeout

pub fn retry(self, retry: u8) -> Self

Sets the retry attempts number

pub fn validate_domain(self, validate_domain: bool) -> Self

Sets if the domain has to be validated

pub fn build(self) -> Config

Return the config and consume the builder

Examples found in repository

examples/tor.rs (line 9)

fn main() {
    // NOTE: This assumes Tor is running localy, with an unauthenticated Socks5 listening at
    // localhost:9050
    let proxy = Socks5Config::new("127.0.0.1:9050");
    let config = ConfigBuilder::new().socks5(Some(proxy)).build();

    let client = Client::from_config("tcp://explorernuoc63nb.onion:110", config.clone()).unwrap();
    let res = client.server_features();
    println!("{:#?}", res);

    // works both with onion v2/v3 (if your Tor supports them)
    let client = Client::from_config(
        "tcp://explorerzydxu5ecjrkwceayqybizmpjjznk5izmitf2modhcusuqlid.onion:110",
        config,
    )
    .unwrap();
    let res = client.server_features();
    println!("{:#?}", res);
}

Trait Implementations

impl Default for ConfigBuilder

fn default() -> Self

Returns the “default value” for a type.