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 (292 forks)batch import
A-patternC-amendmentgood first issue

Repository metrics

Stars
 (6,622 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Familiarize yourself with the existing RAII guards pattern in the Rust Patterns repository. Understand double panic behavior in Rust (panicking while already panicking causes abort). Propose a concise addition to the documentation that warns about implementing Drop on guards that may panic, and suggest best practices (e.g., not panicking in Drop).
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.
1
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.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
RustRAIIpanic safety
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90