require_lifetimes

Crates.iorequire_lifetimes
lib.rsrequire_lifetimes
version0.3.0
sourcesrc
created_at2023-01-07 05:40:48.288239
updated_at2023-01-08 00:05:13.280309
descriptionA proc-macro to force rust authors to write lifetimes in function signatures.
homepage
repositoryhttps://github.com/tfpk/require_lifetimes
max_upload_size
id752785
size29,658
Tom Kunc (tfpk)

documentation

README

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.

Commit count: 4

cargo fmt