| tag | 46b3a05e2ee57fd3e00076cfc16d8f2c0cd1341b | |
|---|---|---|
| tagger | The Android Open Source Project <initial-contribution@android.com> | Mon Apr 27 18:56:37 2020 -0700 |
| object | 2138d75b5e0a7a6428a16f9e194c75d137f9cb29 |
Platform Tools Release 30.0.0 (6405830)
| commit | 2138d75b5e0a7a6428a16f9e194c75d137f9cb29 | [log] [tgz] |
|---|---|---|
| author | android-build-prod (mdb) <android-build-team-robot@google.com> | Fri Apr 17 21:31:41 2020 +0000 |
| committer | android-build-prod (mdb) <android-build-team-robot@google.com> | Fri Apr 17 21:31:41 2020 +0000 |
| tree | d665483788367c5204ad2d837801f99881d5a415 | |
| parent | 1eb909054996a88b605836561cb6fd22fd0e0c61 [diff] | |
| parent | 10a8859e9843ac4938e0942b02c17bbfa4bbd44d [diff] |
Snap for 6405781 from 10a8859e9843ac4938e0942b02c17bbfa4bbd44d to sdk-release Change-Id: If698efd2172d8b80951a6b10bc43789d8c0e730f
This crate provides an attribute macro to check at compile time that the variants of an enum or the arms of a match expression are written in sorted order.
[dependencies] remain = "0.2"
Place a #[remain::sorted] attribute on enums, structs, match-expressions, or let-statements whose value is a match-expression.
Alternatively, import as use remain::sorted; and use #[sorted] as the attribute.
#[remain::sorted] #[derive(Debug)] pub enum Error { BlockSignal(signal::Error), CreateCrasClient(libcras::Error), CreateEventFd(sys_util::Error), CreateSignalFd(sys_util::SignalFdError), CreateSocket(io::Error), DetectImageType(qcow::Error), DeviceJail(io_jail::Error), NetDeviceNew(virtio::NetError), SpawnVcpu(io::Error), } #[remain::sorted] #[derive(Debug)] pub struct Registers { ax: u16, cx: u16, di: u16, si: u16, sp: u16, } impl Display for Error { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { use self::Error::*; #[remain::sorted] match self { BlockSignal(e) => write!(f, "failed to block signal: {}", e), CreateCrasClient(e) => write!(f, "failed to create cras client: {}", e), CreateEventFd(e) => write!(f, "failed to create eventfd: {}", e), CreateSignalFd(e) => write!(f, "failed to create signalfd: {}", e), CreateSocket(e) => write!(f, "failed to create socket: {}", e), DetectImageType(e) => write!(f, "failed to detect disk image type: {}", e), DeviceJail(e) => write!(f, "failed to jail device: {}", e), NetDeviceNew(e) => write!(f, "failed to set up virtio networking: {}", e), SpawnVcpu(e) => write!(f, "failed to spawn VCPU thread: {}", e), } } }
If an enum variant, struct field, or match arm is inserted out of order,
NetDeviceNew(virtio::NetError), SpawnVcpu(io::Error), + AaaUhOh(Box<dyn StdError>), }
then the macro produces a compile error.
error: AaaUhOh should sort before BlockSignal --> tests/stable.rs:49:5 | 49 | AaaUhOh(Box<dyn StdError>), | ^^^^^^^
The attribute on enums and structs is supported on any rustc version 1.31+.
Rust does not yet have stable support for user-defined attributes within a function body, so the attribute on match-expressions and let-statements requires a nightly compiler and the following two features enabled:
#![feature(proc_macro_hygiene, stmt_expr_attributes)]
As a stable alternative, this crate provides a function-level attribute called #[remain::check] which makes match-expression and let-statement attributes work on any rustc version 1.31+. Place this attribute on any function containing #[sorted] to make them work on a stable compiler.
impl Display for Error { #[remain::check] fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { use self::Error::*; #[sorted] match self { /* ... */ } } }