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 (4,472 stars) (253 forks)batch import
help wanted

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

Tech stack
rust
Domain
apideveloper experience
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.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
Basic RustFamiliarity with cxx gen::Error
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70
Research direction
Investigate the current cxx gen::Error struct (likely in cxx gen/src/error.rs). Add methods to expose location information (line, column, file) and possibly a method to return a formatted diagnostic with source snippet. Review how cxx build and cxxbridge cmd produce diagnostics for consistency.