sing_util 0.1.3

Internal functions and types for sing_rs
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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95

// Copyright 2022 Daniel Mowitz
//
// This file is part of sing.
//
// sing is free software: you can redistribute it and/or modify it 
// under the terms of the GNU Affero General Public License 
// as published by the Free Software Foundation, 
// either version 3 of the License, or (at your option) any later version.
//
// sing is distributed in the hope that it will be useful, 
// but WITHOUT ANY WARRANTY; without even the implied warranty
// of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. 
// See the GNU Affero General Public License for more details.
// 
// You should have received a copy of the GNU Affero General Public License
//  along with sing. If not, see <https://www.gnu.org/licenses/>. 

use core::fmt::Debug;
use std::{error::Error, collections::HashMap};

use proc_macro2::TokenStream;
use serde::{Serialize, Deserialize};
pub use serde_wrapper::TokenStreamWrapper;

mod serde_wrapper;

/// Represents a trait as Function names associated with tokenstreams.
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct TraitProfile{
	 functions: HashMap<String, TokenStreamWrapper>,
}	  

impl TraitProfile{
	 pub fn new(funs: HashMap<String, TokenStream>) -> Self {
		  let mut inner = HashMap::new();

		  for (name, stream) in funs {
				inner.insert(name, TokenStreamWrapper::new(stream));
		  }

		  Self{
				functions: inner
		  }
	 }

	 pub fn get_funs(&self) -> Result<HashMap<String, TokenStream>, Box<dyn Error>> {
		  let wrappers = self.functions.clone();
		  let mut funs = HashMap::new();

		  for (name, wrapper) in wrappers {
				funs.insert(name, wrapper.get_inner()?);
		  }

		  Ok(funs)
	 }
}

/// Represents the state of a function name,
/// with it either being only present once or existing multiple times.
#[derive(Debug, Clone)]
pub enum DeduplicatedFunctionProfile {
	 Single(String, TokenStreamWrapper),
	 Multiple(Vec<String>),
}

/// Needs to be implemented by all structs that are used to represent
/// function calls that are sent through a sing I/O stream
pub trait TraitCallMessage {
	 /// The representation of rust data structures that is used internally to store the parameters.
	 /// Usually also the type used by the I/O stream.
	 type Representation;

	 /// Returns the called functions name.
	 fn get_fun_name(&self) -> String;

	 /// Returns the name of the trait the function is called from.
	 fn get_trait_name(&self) -> Option<String>;

	 /// Returns the parameters (or arguments) of the function call.
	 fn get_params(&self) -> Vec<Self::Representation>;

	 /// Replaces the parameters currently stored in this TraitCallMessage object.
	 fn new_params(&mut self, p: Vec<Self::Representation>);
}

#[cfg(test)]
mod tests {

	 #[test]
    fn it_works() {
        let result = 2 + 2;
        assert_eq!(result, 4);
    }

}