ink_ir 5.1.1

data structures and algorithms for ink! intermediate representation
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72

// Copyright (C) Use Ink (UK) Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
//     http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

mod config;
mod item;

#[cfg(test)]
mod tests;

pub use self::{
    config::TraitDefinitionConfig,
    item::{
        InkItemTrait,
        InkTraitItem,
        InkTraitMessage,
        IterInkTraitItems,
    },
};
use super::attrs::InkAttribute;
use proc_macro2::TokenStream as TokenStream2;
use syn::Result;

/// A checked ink! trait definition without its configuration.
#[derive(Debug, PartialEq, Eq)]
pub struct InkTraitDefinition {
    config: TraitDefinitionConfig,
    item: InkItemTrait,
}

impl InkTraitDefinition {
    /// Returns `Ok` if the input matches all requirements for an ink! trait definition.
    pub fn new(config: TokenStream2, input: TokenStream2) -> Result<Self> {
        let parsed_config = syn::parse2::<crate::ast::AttributeArgs>(config)?;
        let parsed_item = syn::parse2::<syn::ItemTrait>(input)?;
        let config = TraitDefinitionConfig::try_from(parsed_config)?;
        let item = InkItemTrait::new(&config, parsed_item)?;
        Ok(Self { config, item })
    }

    /// Constructs an ink! trait definition from its raw parts.
    ///
    /// # Note
    ///
    /// This is a test-only API.
    #[cfg(test)]
    pub fn from_raw_parts(config: TraitDefinitionConfig, item: InkItemTrait) -> Self {
        Self { config, item }
    }
}

impl InkTraitDefinition {
    /// Returns the ink! trait definition config.
    pub fn config(&self) -> &TraitDefinitionConfig {
        &self.config
    }

    /// Returns the ink! trait item representing the ink! trait definition.
    pub fn item(&self) -> &InkItemTrait {
        &self.item
    }
}