Expand description
Returns type names with a specifiable number of module segments as a String.
#[rustfmt::skip]
assert_eq!(
std::any::type_name::<Option<String>>(), "core::option::Option<alloc::string::String>"
);
#[rustfmt::skip]
let tuples = vec![
(tynm::type_name::<Option<String>>(), "Option<String>"),
(tynm::type_namem::<Option<String>>(1), "core::..::Option<alloc::..::String>"),
(tynm::type_namen::<Option<String>>(1), "..::option::Option<..::string::String>"),
// 1 segment from most and least significant modules.
(tynm::type_namemn::<rust_out::two::three::Struct>(1, 1), "rust_out::..::three::Struct"),
// traits
(tynm::type_name::<dyn core::fmt::Debug>(), "dyn Debug"),
];
tuples
.iter()
.for_each(|(left, right)| assert_eq!(left, right));
Motivation
The std::any::type_name function stabilized in Rust 1.38 returns the fully qualified type
name with all module segments. This can be difficult to read in error messages, especially for
type-parameterized types.
Often, the simple type name is more readable, and enough to distinguish the type referenced in an error.
Structs
Helper struct for printing type names directly to format!.
Enums
Organizes type name string into distinct parts.
Functions
Returns the simple type name.
Returns the type name with at most m most significant module path segments.
Returns the type name with m most significant, and n least significant module path segments.
Returns the type name with at most n least significant module path segments.