nordic-dev.net/rust
nordic-dev.net/rust
2
0
Fork 0
mirror of https://github.com/rust-lang/rust.git synced 2025-01-03 03:16:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Rephrase the any::type_name docs a bit.

Browse Source 
This attempts to be a little clearer (including in terminology) about the lack
of guarantees that any::type_name provides.
This commit is contained in:
Laurence Tratt 2020-05-04 10:17:39 +01:00
parent ff4df04799
commit c9f1162a6f
1 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
src/libcore/any.rs
View File

@ -446,14 +446,14 @@ impl TypeId {
/// # Note
///
/// This is intended for diagnostic use. The exact contents and format of the
/// string are not specified, other than being a best-effort description of the
/// type. For example, `type_name::<Option<String>>()` could return the
/// `"Option<String>"` or `"std::option::Option<std::string::String>"`, but not
/// `"foobar"`. In addition, the output may change between versions of the
/// compiler.
/// string retrned are not specified, other than being a best-effort description
/// of the type. For example, amongst the strings
/// that `type_name::<Option<String>>()` might map to are `"Option<String>"` and
/// `"std::option::Option<std::string::String>"`.
///
/// The type name should not be considered a unique identifier of a type;
/// multiple types may share the same type name.
/// The returned string must not be considered to be a unique identifier of a
/// type as multiple types may map to the same type name. In addition, the
/// output may change between versions of the compiler.
///
/// The current implementation uses the same infrastructure as compiler
/// diagnostics and debuginfo, but this is not guaranteed.