ensan 0.2.1

Extended HCL expression evaluator
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

#![doc = include_str!("../README.md")]
#![warn(clippy::complexity)]
#![warn(clippy::correctness)]
#![warn(clippy::nursery)]
#![warn(clippy::pedantic)]
#![warn(clippy::perf)]
#![warn(clippy::style)]
#![warn(clippy::suspicious)]
// followings are from clippy::restriction
#![warn(clippy::missing_errors_doc)]
#![warn(clippy::missing_panics_doc)]
#![warn(clippy::missing_safety_doc)]
#![warn(clippy::unwrap_used)]
#![warn(clippy::expect_used)]
#![warn(clippy::format_push_string)]
#![warn(clippy::get_unwrap)]
#![allow(clippy::missing_inline_in_public_items)]
#![allow(clippy::implicit_return)]
#![allow(clippy::blanket_clippy_restriction_lints)]
#![allow(clippy::pattern_type_mismatch)]
pub mod engine;
pub mod errors;
pub mod functions;
pub mod tests;

pub use engine::Engine;
pub use errors::Error;

/// Quickly evaluate an HCL file
///
/// Outputs a fully-evaluated `hcl::Body` object, which is `hcl-rs`'s representation of an HCL file.
///
/// This type also implements `serde::Deserialize`, so you can easily convert it to any format you want.
///
/// # Errors
/// Failure to parse the HCL or evalutate any expressions would result in an error.
///
/// # Example
///
/// ```rust
/// use hcl::Value;
///
/// let hcl = r#"
/// var "foo" {
///     bar = "baz"
/// }
/// test = var.foo.bar
///
/// "#;
///
/// let expected = r#"
/// var "foo" {
///     bar = "baz"
/// }
/// test = "baz"
///
/// "#;
///
/// let body = ensan::parse(hcl).unwrap();
///
/// let expected_body = hcl::from_str(expected).unwrap();
///
/// assert_eq!(body, expected_body);
///
/// ```
///
pub fn parse(s: impl AsRef<str>) -> Result<hcl::Body, Error> {
    Engine::new().parse(s)
}