#lifetime #author #force #require #write #annotations #proc-macro

macro require_lifetimes

A proc-macro to force rust authors to write lifetimes in function signatures

3 releases (breaking)

0.3.0 Jan 8, 2023
0.2.0 Jan 7, 2023
0.1.0 Jan 7, 2023

#1320 in Procedural macros

Download history 42/week @ 2023-12-03 3/week @ 2023-12-17 2/week @ 2024-02-11 20/week @ 2024-02-18 282/week @ 2024-02-25 322/week @ 2024-03-03 118/week @ 2024-03-10 24/week @ 2024-03-17

747 downloads per month

MIT/Apache

10KB
165 lines

Require Lifetimes

Require Lifetimes is a crate which provides the #[require_lifetimes] annotation. This annotation ensures that the annotated function must have lifetimes for every reference in its signature. In other words, it forces the author to not rely on lifetime elision for a given function. It also stops the author from using the anonymous lifetime '_.

The intent behind this crate is to force the user to actually understand lifetimes. This will be useful when teaching students how lifetimes work, or when trying to write explanatory material. This crate should not be used in production applications, as adding unnecessary lifetimes is an anti-pattern.

Examples

See the ui_tests folder for examples of programs with this annotation. Files ending in _err.rs_ have a corresponding .stderr that shows what their output will be.

Dependencies

~1.5MB
~34K SLoC