macro no-std remain

Compile-time checks that an enum, struct, or match is written in sorted order

18 releases

0.2.11 Jul 21, 2023
0.2.8 Mar 18, 2023
0.2.6 Dec 17, 2022
0.2.5 Oct 25, 2022
0.1.2 Mar 11, 2019

#623 in Development tools

Download history 5321/week @ 2023-06-01 4802/week @ 2023-06-08 4855/week @ 2023-06-15 4671/week @ 2023-06-22 5045/week @ 2023-06-29 6617/week @ 2023-07-06 5601/week @ 2023-07-13 6393/week @ 2023-07-20 5364/week @ 2023-07-27 7429/week @ 2023-08-03 7305/week @ 2023-08-10 6381/week @ 2023-08-17 6332/week @ 2023-08-24 4890/week @ 2023-08-31 7259/week @ 2023-09-07 5583/week @ 2023-09-14

25,019 downloads per month
Used in 43 crates (17 directly)


507 lines

Remain sorted

github crates.io docs.rs build status

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.

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.

pub enum Error {

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::*;

        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,

+     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>),
   |     ^^^^^^^

Compiler support

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 {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        use self::Error::*;

        match self {
            /* ... */


Licensed under either of Apache License, Version 2.0 or MIT license at your option.
Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in this crate by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.


~19K SLoC