Skip to main content

Pinger

Struct Pinger 

Source
pub struct Pinger { /* private fields */ }
Expand description

A pinger that blocks when sending.

This is cheap to clone - clones share the underlying ICMP handles - and is Send + Sync, so a single Pinger can be shared across threads. Note that each send needs its own Buffer, as send takes it by &mut.

Implementations§

Source§

impl Pinger

Source

pub fn new() -> Result<Self, CreateError>

Creates a new Pinger. If one ICMP handle (v4 or v6) fails to initialize, this will return the Pinger embedded in an error. The Pinger is still usable in this state, but sending on the failed version will return an Error. If both v4 and v6 fail, the pinger is not embedded in the error.

Source

pub fn new_v4() -> Option<Self>

Creates a new Pinger, ignoring v6 failures. If you want to use both v4 and v6, use new() instead.

Source

pub fn new_v6() -> Option<Self>

Creates a new Pinger, ignoring v4 failures. If you want to use both v4 and v6, use new() instead.

Source

pub fn set_ttl(&mut self, ttl: u8)

Sets the IP TTL for future requets.

Source

pub fn ttl(&self) -> u8

Gets the current IP TTL value.

Source

pub fn set_df(&mut self, df: bool)

Sets the IP Don’t Fragment bit for future requests.

Source

pub fn df(&self) -> bool

Gets the current IP Don’t Fragment bit.

Source

pub fn set_timeout(&mut self, timeout: u32)

Sets the timeout, in milliseconds, for future requests.

Source

pub fn timeout(&self) -> u32

Gets the current timeout in milliseconds.

Source

pub fn send4(&self, dst: Ipv4Addr, buf: &mut Buffer) -> Result<u32, Error>

Send an ICMPv4 request to the destination address. On success, returns the round trip time in milliseconds.

Source

pub fn send4_from( &self, src: Ipv4Addr, dst: Ipv4Addr, buf: &mut Buffer, ) -> Result<u32, Error>

Sends an ICMPv4 request from the source address to the destination address. On success, returns the round trip time in milliseconds.

Source

pub fn send6(&self, dst: Ipv6Addr, buf: &mut Buffer) -> Result<u32, Error>

Sends an ICMPv6 request to the destination address. On success, returns the round trip time in milliseconds.

Source

pub fn send6_from( &self, src: Ipv6Addr, dst: Ipv6Addr, buf: &mut Buffer, ) -> Result<u32, Error>

Sends an ICMPv6 request from the source address to the destination address. On success, returns the round trip time in milliseconds.

Source

pub fn send(&self, dst: IpAddr, buf: &mut Buffer) -> Result<u32, Error>

Sends an ICMP request to the destination address. Supports both v4 and v6. On success, returns the round trip time in milliseconds.

Source

pub fn send_from( &mut self, src_dst_pair: IpPair, buf: &mut Buffer, ) -> Result<u32, Error>

Sends an ICMP request from the source address to the destination address. Supports both v4 and v6. On success, returns the round trip time in milliseconds.

Trait Implementations§

Source§

impl Clone for Pinger

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.