ink_ir/ir/trait_def/
mod.rs

1// Copyright (C) Use Ink (UK) Ltd.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7//     http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15mod config;
16mod item;
17
18#[cfg(test)]
19mod tests;
20
21pub use self::{
22    config::TraitDefinitionConfig,
23    item::{
24        InkItemTrait,
25        InkTraitItem,
26        InkTraitMessage,
27        IterInkTraitItems,
28    },
29};
30use super::attrs::InkAttribute;
31use proc_macro2::TokenStream as TokenStream2;
32use syn::Result;
33
34/// A checked ink! trait definition without its configuration.
35#[derive(Debug, PartialEq, Eq)]
36pub struct InkTraitDefinition {
37    config: TraitDefinitionConfig,
38    item: InkItemTrait,
39}
40
41impl InkTraitDefinition {
42    /// Returns `Ok` if the input matches all requirements for an ink! trait definition.
43    pub fn new(config: TokenStream2, input: TokenStream2) -> Result<Self> {
44        let parsed_config = syn::parse2::<crate::ast::AttributeArgs>(config)?;
45        let parsed_item = syn::parse2::<syn::ItemTrait>(input)?;
46        let config = TraitDefinitionConfig::try_from(parsed_config)?;
47        let item = InkItemTrait::new(&config, parsed_item)?;
48        Ok(Self { config, item })
49    }
50
51    /// Constructs an ink! trait definition from its raw parts.
52    ///
53    /// # Note
54    ///
55    /// This is a test-only API.
56    #[cfg(test)]
57    pub fn from_raw_parts(config: TraitDefinitionConfig, item: InkItemTrait) -> Self {
58        Self { config, item }
59    }
60}
61
62impl InkTraitDefinition {
63    /// Returns the ink! trait definition config.
64    pub fn config(&self) -> &TraitDefinitionConfig {
65        &self.config
66    }
67
68    /// Returns the ink! trait item representing the ink! trait definition.
69    pub fn item(&self) -> &InkItemTrait {
70        &self.item
71    }
72}
ink_ir/ir/trait_def/mod.rs

ink_ir/ir/trait_def/
mod.rs
