Struct SocketConfig

pub struct SocketConfig<V: IcmpVersion> {
    pub bind_to: Option<V::SocketAddr>,
}

Config for creating sockets.

Most use cases can use SocketConfig::default().

To avoid compatibility concerns when more fields are added, use the .. struct update syntax so that any new fields will be conveniently defaulted in existing invocations:

use std::net;
use async_icmp::{Icmpv4, socket::SocketConfig};

let config: SocketConfig<Icmpv4> = SocketConfig {
    bind_to: Some(net::SocketAddrV4::new(net::Ipv4Addr::LOCALHOST, 1234)),
    ..SocketConfig::default()
};

Fields

bind_to: Option<V::SocketAddr>

The sockaddr to bind the socket to. If specified with Some, the socket is always bound to the address.

If not specified, the behavior depends on the platform. On all supported platforms, a socket’s initial state is bound to the suitable undefined address (0.0.0.0:0 or :::0).

On Linux, explicitly binding that address causes the kernel to select a local port, which is useful for ICMP Echo messages since Linux forces the echo id to be the local port.

On macOS, binding that address makes no difference: an ICMP socket always has zero local port, so the bind is not performed.

Trait Implementations

impl<V: Clone + IcmpVersion> Clone for SocketConfig<V>

where V::SocketAddr: Clone,

fn clone(&self) -> SocketConfig<V>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<V: Debug + IcmpVersion> Debug for SocketConfig<V>

where V::SocketAddr: Debug,

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

Formats the value using the given formatter.

impl<V: IcmpVersion> Default for SocketConfig<V>

fn default() -> Self

Returns the “default value” for a type.