Struct hcl::Template

pub struct Template { /* private fields */ }

The main type to represent the HCL template sub-languange.

A template behaves like an expression that always returns a string value. The different elements of the template are evaluated and combined into a single string to return.

See the module level documentation for usage examples.

Implementations

impl Template

pub fn new() -> Template

Creates an empty template with no elements.

pub fn from_expr(expr: &TemplateExpr) -> Result<Self>

Expands a raw template expression to a template.

Errors

Returns an error if the parsing of raw string templates fails or if the template expression contains string literals with invalid escape sequences.

pub fn elements(&self) -> &[Element]

Returns a reference to the template elements.

pub fn elements_mut(&mut self) -> &mut [Element]

Returns a mutable reference to the template elements.

impl Template

pub fn add_element<T>(self, element: T) -> Template

where T: Into<Element>,

Adds a template element (literal, interpolation or directive) to the template.

pub fn add_literal<T>(self, literal: T) -> Template

where T: Into<String>,

Adds a literal to the template.

pub fn add_interpolation<T>(self, interpolation: T) -> Template

where T: Into<Interpolation>,

Adds an interpolation to the template.

pub fn add_directive<T>(self, directive: T) -> Template

where T: Into<Directive>,

Adds a directive to the template.

Trait Implementations

impl Clone for Template

fn clone(&self) -> Template

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Template

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Template

fn default() -> Template

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Template

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Template

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Evaluate for Template

type Output = String

The type that is returned by evaluate on success.

fn evaluate(&self, ctx: &Context<'_>) -> EvalResult<Self::Output>

Recursively evaluates all HCL templates and expressions in the implementing type using the variables and functions declared in the Context.

fn evaluate_in_place(&mut self, ctx: &Context<'_>) -> EvalResult<(), Errors>

Recursively tries to evaluate all nested expressions in place.

impl Format for Template

fn format<W>(&self, fmt: &mut Formatter<'_, W>) -> Result<()>

where W: Write,

Formats a HCL structure using a formatter and writes the result to the provided writer.

fn format_vec<W>(&self, fmt: &mut Formatter<'_, W>) -> Result<Vec<u8>>

where W: Write + AsMut<Vec<u8>>,

Formats a HCL structure using a formatter and returns the result as a Vec<u8>.

fn format_string<W>(&self, fmt: &mut Formatter<'_, W>) -> Result<String>

where W: Write + AsMut<Vec<u8>>,

Formats a HCL structure using a formatter and returns the result as a String.

impl From<Template> for Template

fn from(value: Template) -> Self

Converts to this type from the input type.

impl From<Template> for Template

fn from(value: Template) -> Self

Converts to this type from the input type.

impl<T> FromIterator<T> for Template

where T: Into<Element>,

fn from_iter<I>(iter: I) -> Self

where I: IntoIterator<Item = T>,

Creates a value from an iterator.

impl FromStr for Template

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for Template

fn eq(&self, other: &Template) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Template

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Template

impl StructuralPartialEq for Template