dtolnay/cxx

Expand API of cxx_gen::Error

Open

#378 opened on Oct 29, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Rust (253 forks)batch import
help wanted

Repository metrics

Stars
 (4,472 stars)
PR merge metrics
 (Avg merge 8m) (3 merged PRs in 30d)

Description

https://docs.rs/cxx-gen/0.5.2/cxx_gen/struct.Error.html currently only exposes a Display/Debug impl which is not sufficient to produce diagnostics in the style that cxx-build and cxxbridge-cmd do. We'll want to expose the location information, and/or possibly a way to retrieve a rendered diagnostic containing the source snippet.

Contributor guide

Research direction
Examine the current Error struct in cxx gen, then add methods to retrieve location information or a rendered diagnostic.
Tech stack
rust
Domain
backend
Issue type
Feature
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.
1-3 hours
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
Rust
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65