Struct Dialer

pub struct Dialer(/* private fields */);

A custom address or dialer for connecting to a host.

A dialer can be created from a URI-like string using FromStr. The following URI schemes are supported:

• tcp: Connect to a TCP address and port pair, like tcp:127.0.0.1:8080.
• unix: Connect to a Unix socket located on the file system, like unix:/path/to/my.sock. This is only supported on Unix.

The Default dialer uses the hostname and port specified in each request as normal.

Examples

Connect to a Unix socket URI:

use isahc::config::Dialer;

let unix_socket = "unix:/path/to/my.sock".parse::<Dialer>()?;

Implementations

impl Dialer

pub fn ip_socket(addr: impl Into<SocketAddr>) -> Self

Connect to the given IP socket.

Any value that can be converted into a SocketAddr can be given as an argument; check the SocketAddr documentation for a complete list.

Examples

use isahc::config::Dialer;
use std::net::Ipv4Addr;

let dialer = Dialer::ip_socket((Ipv4Addr::LOCALHOST, 8080));

use isahc::config::Dialer;
use std::net::SocketAddr;

let dialer = Dialer::ip_socket("0.0.0.0:8765".parse::<SocketAddr>()?);

pub fn unix_socket(path: impl Into<PathBuf>) -> Self

Connect to a Unix socket described by a file.

The path given is not checked ahead of time for correctness or that the socket exists. If the socket is invalid an error will be returned when a request attempt is made.

Examples

use isahc::config::Dialer;

let docker = Dialer::unix_socket("/var/run/docker.sock");

Availability

This function is only available on Unix.

Trait Implementations

impl Clone for Dialer

fn clone(&self) -> Dialer

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Dialer

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

Formats the value using the given formatter.

impl Default for Dialer

fn default() -> Self

Returns the “default value” for a type.

impl From<SocketAddr> for Dialer

fn from(socket_addr: SocketAddr) -> Self

Converts to this type from the input type.

impl FromStr for Dialer

type Err = DialerParseError

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl TryFrom<&str> for Dialer

type Error = DialerParseError

The type returned in the event of a conversion error.

fn try_from(str: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for Dialer

type Error = DialerParseError

The type returned in the event of a conversion error.

fn try_from(string: String) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<Uri> for Dialer

type Error = DialerParseError

The type returned in the event of a conversion error.

fn try_from(uri: Uri) -> Result<Self, Self::Error>

Performs the conversion.