11 releases

0.1.10 Feb 12, 2024
0.1.9 Sep 28, 2023
0.1.8 May 26, 2023
0.1.7 Jan 27, 2023
0.1.0 Dec 29, 2019

#131 in Rust patterns

Download history 3392/week @ 2024-01-31 4465/week @ 2024-02-07 5047/week @ 2024-02-14 4454/week @ 2024-02-21 4375/week @ 2024-02-28 3342/week @ 2024-03-06 3250/week @ 2024-03-13 3933/week @ 2024-03-20 3709/week @ 2024-03-27 3577/week @ 2024-04-03 2869/week @ 2024-04-10 3346/week @ 2024-04-17 3508/week @ 2024-04-24 4075/week @ 2024-05-01 3222/week @ 2024-05-08 2183/week @ 2024-05-15

13,649 downloads per month
Used in 97 crates (18 directly)

MIT/Apache

60KB
1K SLoC

🪶 Tynm -- Type Name

Crates.io docs.rs CI Coverage Status

Returns type names with a specifiable number of module segments as a String.

Usage

Add the following to Cargo.toml

tynm = "0.1.10"

In code:

#[rustfmt::skip]
assert_eq!(
    core::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 core::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.

License

Licensed under either of

at your option.

Contribution

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Dependencies

~0.9–1.3MB
~24K SLoC