FuelLabs/sway

Consider making `CompileResult` members private.

Open

#2475 aperta il 8 ago 2022

Vedi su GitHub
 (0 commenti) (1 reazione) (0 assegnatari)Rust (5421 fork)batch import
P: mediumcode qualitycompiler: frontendenhancementgood first issueteam:compiler

Metriche repository

Star
 (61.702 star)
Metriche merge PR
 (Merge medio 22h 6m) (16 PR mergiate in 30 g)

Descrizione

When reviewing #2472 I noticed it's possible to accidentally make an invalid CompileResult, where the author intended to return an 'ok' but set value to None.

We should make it mandatory to use CompileResult::ok() and CompileResult::err() to avoid this sort of thing. It would also required making a bunch of access methods for pulling the value or errors and/or warnings out which may turn out to be quite a pervasive change.

Guida contributor

Direzione di ricerca
Identifica tutti gli accessi diretti ai campi di CompileResult, aggiungi metodi getter (es. value(), errors(), warnings()), quindi rendi i campi privati. Assicurati che tutto il codice esistente utilizzi la nuova API.
Tech stack
rust
Dominio
compilers
Tipo issue
Refactoring
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Nuova
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
Rust
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
50