Opened 2 months ago

Last modified 7 weeks ago

#25628 new enhancement

Document our Rust coding standards for error/failure types

Reported by: isis Owned by:
Priority: Medium Milestone: Tor: unspecified
Component: Core Tor/Tor Version:
Severity: Normal Keywords: rust, tor-doc, 034-triage-20180328, 034-removed-20180328
Cc: chelseakomlo Actual Points:
Parent ID: Points:
Reviewer: Sponsor: Sponsor8-can

Description

Every crate which returns Result<T, E>s or Option<T> anywhere in its public interface should have an errors.rs module containing error types which implement either Display or Debug, and also ::failure::Fail for making errors easier to work with between crates. See the errors.rs addition to the protover crate from #24031 for an example (doesn't have the ::failure::Fail impl yet, because the failure crate is about to become 1.0.0 any day now).

We should probably wait on this until failure is 1.0.0.

Child Tickets

Change History (3)

comment:1 Changed 2 months ago by nickm

Keywords: 034-triage-20180328 added

comment:2 Changed 2 months ago by nickm

Keywords: 034-removed-20180328 added

Per our triage process, these tickets are pending removal from 0.3.4.

comment:3 Changed 7 weeks ago by nickm

Milestone: Tor: 0.3.4.x-finalTor: unspecified

These tickets, tagged with 034-removed-*, are no longer in-scope for 0.3.4. We can reconsider any of them, if time permits.

Note: See TracTickets for help on using tickets.