frame_support_procedural/pallet/parse/
origin.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 of the pallet origin type.
22///
23/// Either:
24/// * `type Origin`
25/// * `struct Origin`
26/// * `enum Origin`
27pub struct OriginDef {
28	pub is_generic: bool,
29	/// A set of usage of instance, must be check for consistency with trait.
30	pub instances: Vec<helper::InstanceUsage>,
31}
32
33impl OriginDef {
34	pub fn try_from(item: &mut syn::Item) -> syn::Result<Self> {
35		let item_span = item.span();
36		let (vis, ident, generics) = match &item {
37			syn::Item::Enum(item) => (&item.vis, &item.ident, &item.generics),
38			syn::Item::Struct(item) => (&item.vis, &item.ident, &item.generics),
39			syn::Item::Type(item) => (&item.vis, &item.ident, &item.generics),
40			_ => {
41				let msg = "Invalid pallet::origin, expected enum or struct or type";
42				return Err(syn::Error::new(item.span(), msg))
43			},
44		};
45
46		let is_generic = !generics.params.is_empty();
47
48		let mut instances = vec![];
49		if let Some(u) = helper::check_type_def_optional_gen(generics, item.span())? {
50			instances.push(u);
51		} else {
52			// construct_runtime only allow generic event for instantiable pallet.
53			instances.push(helper::InstanceUsage { has_instance: false, span: ident.span() })
54		}
55
56		if !matches!(vis, syn::Visibility::Public(_)) {
57			let msg = "Invalid pallet::origin, Origin must be public";
58			return Err(syn::Error::new(item_span, msg))
59		}
60
61		if ident != "Origin" {
62			let msg = "Invalid pallet::origin, ident must `Origin`";
63			return Err(syn::Error::new(ident.span(), msg))
64		}
65
66		Ok(OriginDef { is_generic, instances })
67	}
68}
frame_support_procedural/pallet/parse/origin.rs

frame_support_procedural/pallet/parse/
origin.rs
