Struct Report

pub struct Report {

    pub udp: bool,
    pub ipv6: bool,
    pub ipv4: bool,
    pub ipv6_can_send: bool,
    pub ipv4_can_send: bool,
    pub os_has_ipv6: bool,
    pub icmpv4: Option<bool>,
    pub icmpv6: Option<bool>,
    pub mapping_varies_by_dest_ip: Option<bool>,
    pub mapping_varies_by_dest_ipv6: Option<bool>,
    pub hair_pinning: Option<bool>,
    pub portmap_probe: Option<ProbeOutput>,
    pub preferred_relay: Option<RelayUrl>,
    pub relay_latency: RelayLatencies,
    pub relay_v4_latency: RelayLatencies,
    pub relay_v6_latency: RelayLatencies,
    pub global_v4: Option<SocketAddrV4>,
    pub global_v6: Option<SocketAddrV6>,
    pub captive_portal: Option<bool>,
}

A netcheck report.

Can be obtained by calling Client::get_report.

Fields

udp: bool

A UDP STUN round trip completed.

ipv6: bool

An IPv6 STUN round trip completed.

ipv4: bool

An IPv4 STUN round trip completed.

ipv6_can_send: bool

An IPv6 packet was able to be sent

ipv4_can_send: bool

an IPv4 packet was able to be sent

os_has_ipv6: bool

could bind a socket to ::1

icmpv4: Option<bool>

An ICMPv4 round trip completed, None if not checked.

icmpv6: Option<bool>

An ICMPv6 round trip completed, None if not checked.

mapping_varies_by_dest_ip: Option<bool>

Whether STUN results depend on which STUN server you’re talking to (on IPv4).

mapping_varies_by_dest_ipv6: Option<bool>

Whether STUN results depend on which STUN server you’re talking to (on IPv6).

Note that we don’t really expect this to happen and are merely logging this if detecting rather than using it. For now.

hair_pinning: Option<bool>

Whether the router supports communicating between two local devices through the NATted public IP address (on IPv4).

portmap_probe: Option<ProbeOutput>

Probe indicating the presence of port mapping protocols on the LAN.

preferred_relay: Option<RelayUrl>

None for unknown

relay_latency: RelayLatencies

keyed by relay Url

relay_v4_latency: RelayLatencies

keyed by relay Url

relay_v6_latency: RelayLatencies

keyed by relay Url

global_v4: Option<SocketAddrV4>

ip:port of global IPv4

global_v6: Option<SocketAddrV6>

[ip]:port of global IPv6

captive_portal: Option<bool>

CaptivePortal is set when we think there’s a captive portal that is intercepting HTTP traffic.

Trait Implementations

impl Clone for Report

fn clone(&self) -> Report

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Report

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

Formats the value using the given formatter.

impl Default for Report

fn default() -> Report

Returns the “default value” for a type.

impl Display for Report

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

Formats the value using the given formatter.

impl PartialEq for Report

fn eq(&self, other: &Report) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Report

impl StructuralPartialEq for Report