search

quinn-rs / quinn

Async-friendly QUIC implementation in Rust
Apache License 2.0
3.52k stars 356 forks source link

Inconsistent documentation on platform availability of `local_ip` #1864

Closed Pixelstormer closed 2 weeks ago

Pixelstormer commented 2 weeks ago

Of the three local_ip methods that exist on quinn_proto::Connection, quinn::Connection, and quinn::Connecting, they each list a different set of platforms on which the method is supposedly available.

The proto Connection lists Linux and Windows, the quinn Connection lists only Linux, and Connecting lists Linux, FreeBSD and macOS. The documentation of all three of these functions should be reconciled to whatever the true set of supported platforms is.

Ralith commented 2 weeks ago

Thanks for the report! We should probably list this information in one place and link to it from elsewhere to avoid drift in the future.

djc commented 2 weeks ago

I think perhaps quinn-proto should not document platform support, because availability seems fully dependent on the caller?

djc commented 2 weeks ago

So I think the current list is:

For implementations that use an AsyncUdpSocket based on quinn-udp.