Skip to content

docs: Fix stale IPv6 platform claims in rustdoc #55

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dweekly merged 1 commit into from
Jul 20, 2026
Merged

docs: Fix stale IPv6 platform claims in rustdoc #55

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@
//!
//! // Other structured errors
//! Err(TracerouteError::Ipv6NotSupported) => {
//! eprintln!("IPv6 targets are not yet supported");
//! eprintln!("IPv6 targets are not supported on this platform");
//! }
//! Err(TracerouteError::ResolutionError(msg)) => {
//! eprintln!("DNS resolution failed: {}", msg);
Expand Down
2 changes: 1 addition & 1 deletion src/traceroute.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
//!
//! - **`InsufficientPermissions`** - Includes what permissions are needed and suggestions
//! - **`NotImplemented`** - Feature not yet implemented (e.g., TCP traceroute)
//! - **`Ipv6NotSupported`** - IPv6 targets not yet supported
//! - **`Ipv6NotSupported`** - IPv6 targets not supported on this platform
//! - **`ResolutionError`** - DNS resolution failed
//! - **`SocketError`** - Socket creation/operation failed
//! - **`ConfigError`** - Invalid configuration
Expand Down
12 changes: 7 additions & 5 deletions src/traceroute/config.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,13 @@ impl Default for TimingConfig {
/// # Default (`Auto`)
///
/// `Auto` prefers IPv4 when a host has both A and AAAA records, and uses
/// IPv6 only when the host is v6-only. This is a deliberately conservative
/// default while IPv6 probing is new (currently macOS-only): a dual-stack
/// host keeps yielding exactly the same trace as previous ftr releases on
/// every platform, and platforms without IPv6 probe support quietly keep
/// working. Pass `V6` (CLI `-6`) to opt in for dual-stack hosts.
/// IPv6 only when the host is v6-only. IPv6 probing is supported on every
/// platform (macOS/Linux/BSD since 0.9.0, Windows since 0.10.0); the
/// v4-first default is kept for behavioral compatibility — a dual-stack
/// host yields exactly the same trace as pre-0.9 ftr releases. This is
/// deliberately not Happy Eyeballs: the OS may prefer IPv6 for its own
/// connections to the same host. Pass `V6` (CLI `-6`) to opt in for
/// dual-stack hosts.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Default, Serialize, Deserialize)]
pub enum PreferredFamily {
/// Only resolve to IPv4; error if the host has no A records
Expand Down
4 changes: 3 additions & 1 deletion src/traceroute/error.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,9 @@ pub enum TracerouteError {
feature: String,
},

/// IPv6 targets are not yet supported
/// IPv6 targets are not supported on this platform (all tier-1
/// platforms — macOS, Linux, Windows, the BSDs — support IPv6; only
/// other OSes return this)
#[error("IPv6 targets are not yet supported")]
Ipv6NotSupported,

Expand Down
Loading