sp_debug_derive/lib.rs
1// This file is part of Substrate.
2
3// Copyright (C) Parity Technologies (UK) Ltd.
4// SPDX-License-Identifier: Apache-2.0
5
6// Licensed under the Apache License, Version 2.0 (the "License");
7// you may not use this file except in compliance with the License.
8// You may obtain a copy of the License at
9//
10// http://www.apache.org/licenses/LICENSE-2.0
11//
12// Unless required by applicable law or agreed to in writing, software
13// distributed under the License is distributed on an "AS IS" BASIS,
14// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
15// See the License for the specific language governing permissions and
16// limitations under the License.
17
18//! Macros to derive runtime debug implementation.
19//!
20//! This custom derive implements a `core::fmt::Debug` trait,
21//! but in case the `std` feature is enabled the implementation
22//! will actually print out the structure as regular `derive(Debug)`
23//! would do. If `std` is disabled the implementation will be empty.
24//!
25//! This behaviour is useful to prevent bloating the runtime WASM
26//! blob from unneeded code.
27//!
28//! ```rust
29//! #[derive(sp_debug_derive::RuntimeDebug)]
30//! struct MyStruct;
31//!
32//! assert_eq!(format!("{:?}", MyStruct), "MyStruct");
33//! ```
34
35mod impls;
36
37use proc_macro::TokenStream;
38
39#[proc_macro_derive(RuntimeDebug)]
40pub fn debug_derive(input: TokenStream) -> TokenStream {
41 impls::debug_derive(syn::parse_macro_input!(input))
42}