Skip to content
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.

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

Ipv6Addr::is_documentation should be expanded to include RFC 9637's 3ffff::/20 #137821

Open
jrose-signal opened this issue Feb 28, 2025 · 1 comment
Labels
C-bug Category: This is a bug. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.

Comments

@jrose-signal
Copy link

The unstable Ipv6Addr::is_documentation (#27709) is documented, matching the implementation, as

Returns true if this is an address reserved for documentation (2001:db8::/32).

This property is defined in IETF RFC 3849.

However, RFC 9637 from Aug 2024 added 3fff::/20 as a documentation space as well, and thus this API should be updated.

This does mean two programs may disagree on whether an address is_documentation based on which version of the stdlib they use…but I think that's inevitable with anything based on IETF standards. (In some cases it might make sense to explicitly pin the library to an earlier version of the standard, but I don't think that's necessary here.)

@jrose-signal jrose-signal added the C-bug Category: This is a bug. label Feb 28, 2025
@rustbot rustbot added the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Feb 28, 2025
@lolbinarycat lolbinarycat added the T-libs-api Relevant to the library API team, which will review and decide on the PR/issue. label Mar 1, 2025
@jieyouxu jieyouxu removed the needs-triage This issue may need triage. Remove it if it has been sufficiently triaged. label Mar 1, 2025
@the8472
Copy link
Member

the8472 commented Mar 1, 2025

This does mean two programs may disagree on whether an address is_documentation based on which version of the stdlib they use

Even if that were a concern (I don't think it is), the feature is unstable so we're free to change it anyway.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
C-bug Category: This is a bug. T-libs-api Relevant to the library API team, which will review and decide on the PR/issue.
Projects
None yet
Development

No branches or pull requests

5 participants