Modules§
- de
- Deserialize HCL data to a Rust data structure.
- edit
- hcl-edit
- error
- The
ErrorandResulttypes used by this crate. - eval
- Evaluate HCL templates and expressions.
- expr
- Types to represent the HCL expression sub-language.
- format
- Format data structures as HCL.
- ser
- Serialize a Rust data structure into HCL data.
- structure
- Types to represent the HCL structural sub-language.
- template
- Types to represent the HCL template sub-language.
- value
- The Value enum, a loosely typed way of representing any valid HCL value.
Macros§
- attribute
- Construct an
hcl::Attributefrom a key and a value expression. - block
- Construct an
hcl::Blockfrom a block identifier, optional block labels and a block body. - body
- Construct an
hcl::Bodyfrom HCL blocks and attributes. - expression
- Construct an
hcl::Expressionfrom an HCL attribute value expression literal. - structure
- Construct an
hcl::Structurewhich may be either an HCL attribute or block. - value
- Construct an
hcl::Valuefrom an HCL attribute value value literal.
Structs§
- Attribute
- Represents an HCL attribute which consists of an attribute key and a value expression.
- Binary
Op - An operation that applies an operator to two expressions.
- Block
- Represents an HCL block which consists of a block identifier, zero or more block labels and a block body.
- Block
Builder BlockBuilderbuilds an HCLBlock.- Body
- Represents an HCL config file body.
- Body
Builder BodyBuilderbuilds a HCLBody.- Code
Reference - Conditional
- The conditional operator allows selecting from one of two expressions based on the outcome of a boolean expression.
- ForExpr
- A for expression is a construct for constructing a collection by projecting the items from another collection.
- FreshTF
Work Dir - Func
Call - Represents a function call expression with zero or more arguments.
- Func
Call Builder - A builder for function calls.
- Generated
Config OutTF Work Dir - HclImport
Block - Heredoc
- A heredoc template expression is introduced by a
<<sequence and defines a template via a multi-line sequence terminated by a user-chosen delimiter. - Identifier
- Represents an HCL identifier.
- InitializedTF
Work Dir - Internal
String - An opaque string storage which inlines small strings on the stack if the
perffeature is enabled. - Location
Within File - Number
- Represents an HCL number.
- Other
Data Block Kind - Other
Resource Block Kind - ProcessedTF
Work Dir - Provider
Availability - Provider
Hostname - Provider
Namespace - Provider
Source - https://developer.hashicorp.com/terraform/language/providers/requirements#source-addresses
- Provider
Version Constraint - Provider
Version Object - SemVer
- Template
- The main type to represent the HCL template sub-languange.
- Terraform
AzureRM Backend Block - Terraform
Block - Terraform
Plan - Terraform
Plan Planned Values - Terraform
Plan Planned Values Resource - Terraform
Plan Planned Values Root Module - Terraform
Plan Resource Change - Terraform
Plan Resource Change Change - Terraform
Provider Info - Terraform
Required Providers Block - https://developer.hashicorp.com/terraform/language/providers/requirements#version-constraints
- Traversal
- Traverse an expression to access attributes, object keys or element indices.
- UnaryOp
- An operation that applies an operator to one expression.
- Users
Lookup Body - ValidatedTF
Work Dir - Variable
- A type representing a variable in an HCL expression.
Enums§
- Azure
AdData Block Kind - Azure
AdResource Block Kind - Azure
DevOps Data Block Kind - Azure
DevOps Resource Block Kind - Azure
RmData Block Kind - Azure Resource Manager data block kind
- Azure
RmResource Block Kind - Binary
Operator - An operator that can be applied to two expressions.
- Block
Label - Represents an HCL block label.
- Data
Block Reference - Data
Block Resource Kind - Error
- The error type used by this crate.
- Expression
- A type representing the expression sub-language. It is used in HCL attributes to specify values and in HCL templates.
- HclBlock
- HclBlock
Kind - HclData
Block - HclProvider
Block - HclProvider
Reference - HclResource
Block - Heredoc
Strip Mode - The strip behaviour for the template contained in the heredoc.
- Object
Key - Represents an object key.
- Operation
- Operations apply a particular operator to either one or two expression terms.
- Provider
Kind - Provider
Version Constraint Clause - https://developer.hashicorp.com/terraform/language/expressions/version-constraints#operators
- Resource
Block Reference - Resource
Block Resource Kind - Structure
- Represents an HCL structure.
- TFWork
DirInitialization State - TFWork
DirKind - TFWork
DirValidation State - Template
Expr - A template expression embeds a program written in the template sub-language as an expression.
- Terraform
Backend Block - Terraform
Change Action - https://developer.hashicorp.com/terraform/internals/json-format#change-representation
- Terraform
Plan Resource Mode - Traversal
Operator - The expression traversal operators that are supported by HCL.
- Unary
Operator - An operator that can be applied to an expression.
- Value
- Represents any valid HCL value.
Traits§
Functions§
- from_
body - Interpret a
hcl::Bodyas an instance of typeT. - from_
reader - Deserialize an instance of type
Tfrom an IO stream of HCL. - from_
slice - Deserialize an instance of type
Tfrom a byte slice. - from_
str - Deserialize an instance of type
Tfrom a string of HCL text. - from_
value - Convert a
hcl::Valueinto a typeTthat implementsserde::Deserialize. - parse
- Parse a
hcl::Bodyfrom a&str. - to_
expression - Convert a
Tintohcl::Expressionwhich is an enum that can represent any valid HCL attribute value expression. - to_
string - Serialize the given value as an HCL string.
- to_
value - Convert a
Tintohcl::Valuewhich is an enum that can represent any valid HCL value. - to_vec
- Serialize the given value as an HCL byte vector.
- to_
writer - Serialize the given value as HCL into the IO stream.