Struct PingerBuilder 

pub struct PingerBuilder { /* private fields */ }

Builder for a Pinger with socket level options.

let mut pinger = Pinger::builder()
    .socket_type(SocketType::RAW)
    .ident(1234)
    .build()?;

Implementations

impl PingerBuilder

pub fn new() -> Self

Creates a builder with default options.

pub fn socket_type(self, socket_type: SocketType) -> Self

Uses only the given socket type.

By default a datagram socket is tried first on Linux, Android and macOS, falling back to a raw socket, and the other way around on other platforms.

pub fn ident(self, ident: u16) -> Self

Sets the ICMP identifier. A random one is used by default.

On Linux datagram sockets the identifier is the port the socket is bound to. Do not share an identifier between pingers there: depending on the kernel, the first ping either fails with an Error::IoError, or succeeds and replies are then delivered to only one of the pingers.

pub fn bind_device(self, device: impl Into<String>) -> Self

Binds the sockets to a network interface by name, such as "eth0".

pub fn mark(self, mark: u32) -> Self

Sets the SO_MARK (fwmark) of the sockets, used by policy routing.

pub fn build(self) -> Result<Pinger, Error>

Creates the pinger. Sockets are opened lazily by the first ping to each address family.

pub fn build_tokio(self) -> Result<Pinger, Error>

Creates an asynchronous tokio::Pinger with the same options. Available with the tokio feature.

let mut pinger = Pinger::builder()
    .socket_type(SocketType::RAW)
    .build_tokio()?;

Trait Implementations

impl Clone for PingerBuilder

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PingerBuilder

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

Formats the value using the given formatter.

impl Default for PingerBuilder

fn default() -> Self

Returns the “default value” for a type.