diff mbox series

[v1,08/28] rust: error: declare errors using macro

Message ID	20221110164152.26136-9-ojeda@kernel.org
State	New
Headers	Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::1:20 as permitted sender) client-ip=2620:137:e000::1:20; From: Miguel Ojeda <ojeda@kernel.org> To: Miguel Ojeda <ojeda@kernel.org>, Wedson Almeida Filho <wedsonaf@gmail.com>, Alex Gaynor <alex.gaynor@gmail.com>, Boqun Feng <boqun.feng@gmail.com>, Gary Guo <gary@garyguo.net>, =?utf-8?q?Bj=C3=B6rn_Roy_Baron?= <bjorn3_gh@protonmail.com> Cc: rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org, patches@lists.linux.dev, Finn Behrens <me@kloenk.dev> Subject: [PATCH v1 08/28] rust: error: declare errors using macro Date: Thu, 10 Nov 2022 17:41:20 +0100 Message-Id: <20221110164152.26136-9-ojeda@kernel.org> In-Reply-To: <20221110164152.26136-1-ojeda@kernel.org> References: <20221110164152.26136-1-ojeda@kernel.org> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit Precedence: bulk
Series	Rust core additions \| [v1,00/28] Rust core additions [v1,01/28] rust: prelude: split re-exports into groups [v1,02/28] rust: print: add more `pr_!` levels [v1,03/28] rust: print: add `pr_cont!` macro [v1,04/28] rust: samples: add `rust_print` example [v1,05/28] rust: macros: add `concat_idents!` proc macro [v1,06/28] rust: macros: add `#[vtable]` proc macro [v1,07/28] rust: macros: take string literals in `module!` [v1,08/28] rust: error: declare errors using macro [v1,09/28] rust: error: add codes from `errno-base.h` [v1,10/28] rust: error: add `From` implementations for `Error` [v1,11/28] rust: prelude: add `error::code::` constant items [v1,12/28] rust: alloc: add `RawVec::try_with_capacity_in()` constructor [v1,13/28] rust: alloc: add `Vec::try_with_capacity{,_in}()` constructors [v1,14/28] rust: str: add `BStr` type [v1,15/28] rust: str: add `b_str!` macro [v1,16/28] rust: str: add `CStr` type [v1,17/28] rust: str: implement several traits for `CStr` [v1,18/28] rust: str: add `CStr` unit tests [v1,19/28] rust: str: add `c_str!` macro [v1,20/28] rust: str: add `Formatter` type [v1,21/28] rust: str: add `CString` type [v1,22/28] rust: str: add `fmt!` macro [v1,23/28] rust: std_vendor: add `dbg!` macro based on `std`'s one [v1,24/28] rust: static_assert: add `static_assert!` macro [v1,25/28] rust: add `build_error` crate [v1,26/28] rust: build_assert: add `build_{error,assert}!` macros [v1,27/28] rust: types: add `Either` type [v1,28/28] rust: types: add `Opaque` type

Commit Message

Miguel Ojeda Nov. 10, 2022, 4:41 p.m. UTC

  From: Finn Behrens <me@kloenk.dev>

Add a macro to declare errors, which simplifies the work needed to
add each one, avoids repetition of the code and makes it easier to
change the way they are declared.

Signed-off-by: Finn Behrens <me@kloenk.dev>
[Reworded, adapted for upstream and applied latest changes]
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
 rust/kernel/error.rs | 12 ++++++++++--
 1 file changed, 10 insertions(+), 2 deletions(-)

Comments

Gary Guo Nov. 14, 2022, 2:28 p.m. UTC | #1

On Thu, 10 Nov 2022 17:41:20 +0100
Miguel Ojeda <ojeda@kernel.org> wrote:

> From: Finn Behrens <me@kloenk.dev>
> 
> Add a macro to declare errors, which simplifies the work needed to
> add each one, avoids repetition of the code and makes it easier to
> change the way they are declared.
> 
> Signed-off-by: Finn Behrens <me@kloenk.dev>
> [Reworded, adapted for upstream and applied latest changes]
> Signed-off-by: Miguel Ojeda <ojeda@kernel.org>

Reviewed-by: Gary Guo <gary@garyguo.net>

> ---
>  rust/kernel/error.rs | 12 ++++++++++--
>  1 file changed, 10 insertions(+), 2 deletions(-)
> 
> diff --git a/rust/kernel/error.rs b/rust/kernel/error.rs
> index 466b2a8fe569..b843f3445483 100644
> --- a/rust/kernel/error.rs
> +++ b/rust/kernel/error.rs
> @@ -8,8 +8,16 @@ use alloc::collections::TryReserveError;
>  
>  /// Contains the C-compatible error codes.
>  pub mod code {
> -    /// Out of memory.
> -    pub const ENOMEM: super::Error = super::Error(-(crate::bindings::ENOMEM as i32));
> +    macro_rules! declare_err {
> +        ($err:tt $(,)? $($doc:expr),+) => {
> +            $(
> +            #[doc = $doc]
> +            )*
> +            pub const $err: super::Error = super::Error(-(crate::bindings::$err as i32));
> +        };
> +    }
> +
> +    declare_err!(ENOMEM, "Out of memory.");
>  }
>  
>  /// Generic integer kernel error.

diff mbox series

Patch

diff --git a/rust/kernel/error.rs b/rust/kernel/error.rs
index 466b2a8fe569..b843f3445483 100644
--- a/rust/kernel/error.rs
+++ b/rust/kernel/error.rs
@@ -8,8 +8,16 @@  use alloc::collections::TryReserveError;
 
 /// Contains the C-compatible error codes.
 pub mod code {
-    /// Out of memory.
-    pub const ENOMEM: super::Error = super::Error(-(crate::bindings::ENOMEM as i32));
+    macro_rules! declare_err {
+        ($err:tt $(,)? $($doc:expr),+) => {
+            $(
+            #[doc = $doc]
+            )*
+            pub const $err: super::Error = super::Error(-(crate::bindings::$err as i32));
+        };
+    }
+
+    declare_err!(ENOMEM, "Out of memory.");
 }
 
 /// Generic integer kernel error.