Skip to content

Document when references (both shared and exclusive) implement RefUnwindSafe #150218

@eggyal

Description

@eggyal

Location (URL)

https://doc.rust-lang.org/std/panic/trait.RefUnwindSafe.html

and

https://doc.rust-lang.org/std/primitive.reference.html

Summary

The prose of the Primitive Type reference page documents when various traits are implemented for references (both shared and exclusive). Notably it includes some auto traits, such as Send and Sync—but not others, such as Unpin, UnwindSafe or RefUnwindSafe.

Fortunately, the pages for those traits do document when they are implemented for reference types—except in the case of RefUnwindSafe! Indeed I cannot find it documented anywhere when RefUnwindSafe is implemented for &T or &mut T (I assume, in both cases, when T: RefUnwindSafe though I am not 100% certain).

At the very least, the RefUnwindSafe page should include the implementations for reference types.

Furthermore, for completeness, the prose of the Primitive Type reference page should probably include Unpin, UnwindSafe and RefUnwindSafe.

Metadata

Metadata

Assignees

No one assigned

    Labels

    A-docsArea: Documentation for any part of the project, including the compiler, standard library, and toolsT-libsRelevant to the library team, which will review and decide on the PR/issue.

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions