frame_support_procedural/pallet/parse/
genesis_config.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
18use super::helper;
19use syn::spanned::Spanned;
20
21/// Definition for pallet genesis config type.
22///
23/// Either:
24/// * `struct GenesisConfig`
25/// * `enum GenesisConfig`
26pub struct GenesisConfigDef {
27	/// The index of item in pallet module.
28	pub index: usize,
29	/// The kind of generic the type `GenesisConfig` has.
30	pub gen_kind: super::GenericKind,
31	/// A set of usage of instance, must be check for consistency with trait.
32	pub instances: Vec<helper::InstanceUsage>,
33	/// The ident of genesis_config, can be used for span.
34	pub genesis_config: syn::Ident,
35}
36
37impl GenesisConfigDef {
38	pub fn try_from(index: usize, item: &mut syn::Item) -> syn::Result<Self> {
39		let item_span = item.span();
40		let (vis, ident, generics) = match &item {
41			syn::Item::Enum(item) => (&item.vis, &item.ident, &item.generics),
42			syn::Item::Struct(item) => (&item.vis, &item.ident, &item.generics),
43			_ => {
44				let msg = "Invalid pallet::genesis_config, expected enum or struct";
45				return Err(syn::Error::new(item.span(), msg))
46			},
47		};
48
49		let mut instances = vec![];
50		// NOTE: GenesisConfig is not allowed to be only generic on I because it is not supported
51		// by construct_runtime.
52		if let Some(u) = helper::check_type_def_optional_gen(generics, ident.span())? {
53			instances.push(u);
54		}
55
56		let has_instance = generics.type_params().any(|t| t.ident == "I");
57		let has_config = generics.type_params().any(|t| t.ident == "T");
58		let gen_kind = super::GenericKind::from_gens(has_config, has_instance)
59			.expect("Checked by `helper::check_type_def_optional_gen` above");
60
61		if !matches!(vis, syn::Visibility::Public(_)) {
62			let msg = "Invalid pallet::genesis_config, GenesisConfig must be public";
63			return Err(syn::Error::new(item_span, msg))
64		}
65
66		if ident != "GenesisConfig" {
67			let msg = "Invalid pallet::genesis_config, ident must `GenesisConfig`";
68			return Err(syn::Error::new(ident.span(), msg))
69		}
70
71		Ok(GenesisConfigDef { index, genesis_config: ident.clone(), instances, gen_kind })
72	}
73}
frame_support_procedural/pallet/parse/genesis_config.rs

frame_support_procedural/pallet/parse/
genesis_config.rs
