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

#![allow(clippy::needless_return, clippy::redundant_field_names)]
#![deny(clippy::implicit_return)]
pub mod environment;
pub mod embed;
pub mod databases;
pub mod regexes;

/// Trait used for implementing keys
pub trait Key {
	/// Returns a reference to a [KeyInfo] describing the key
	fn get_key_info(&self) -> &KeyInfo;
	/// Returns the key function that gets called during interpretation
	fn get_key_function(&self) -> fn(parameter: &[String], environment: &mut environment::Environment) -> Result<String, String>;
}

/// Struct describing the key
#[derive(Clone, Debug)]
pub struct KeyInfo {
	/// How many parameters the key takes
	/// Contains every possible variation, like `[1, 3, 4]`
	pub parameters_required: Vec<usize>,
	/// The key's name
	/// Must be unique
	pub name: String,
}