rust-unofficial/patterns

Add double panic mentioning for RAII guards

Open

#327 opened on Nov 27, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)Shell (6,622 stars) (292 forks)batch import
A-patternC-amendmentgood first issue

Description

I think it would be nice to mention that one should be careful when writing drop implementations on guards relatively to the double panic possibility when they find out about this pattern for the first time or are unaware of double panicking generally.

It might help someone inexperienced I suppose.

Contributor guide

Tech stack
rust
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
RustRAII guardsdouble panic
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
80
Research direction
Look at the existing documentation for RAII guards in the patterns repository (likely in the 'RAII' or 'Drop' pattern). Add a note about double panic possibility when implementing Drop on guards, citing Rust's double panic behavior. Reference https://doc.rust lang.org/nomicon/dropck.html or similar. The issue has no comments from maintainers, so propose a specific location and wording.
Add double panic mentioning for RAII guards · rust-unofficial/patterns#327 | Good First Issue