Struct BodyBuilder

pub struct BodyBuilder { /* private fields */ }

BodyBuilder builds a HCL Body.

The builder allows to build the Body by adding attributes and other nested blocks via chained method calls. A call to .build() produces the final Body.

Example

use hcl_edit::structure::{Attribute, Block, Body};
use hcl_edit::Ident;

let body = Body::builder()
    .block(
        Block::builder(Ident::new("resource"))
            .labels(["aws_s3_bucket", "mybucket"])
            .attribute(Attribute::new(Ident::new("name"), "mybucket"))
    )
    .build();

Implementations

impl BodyBuilder

pub fn attribute(self, attr: impl Into<Attribute>) -> BodyBuilder

Adds an Attribute to the body.

Consumes self and returns a new BodyBuilder.

pub fn attributes<I>(self, iter: I) -> BodyBuilder

where I: IntoIterator, I::Item: Into<Attribute>,

Adds Attributes to the body from an iterator.

Consumes self and returns a new BodyBuilder.

pub fn block(self, block: impl Into<Block>) -> BodyBuilder

Adds a Block to the body.

Consumes self and returns a new BodyBuilder.

pub fn blocks<I>(self, iter: I) -> BodyBuilder

where I: IntoIterator, I::Item: Into<Block>,

Adds Blocks to the body from an iterator.

Consumes self and returns a new BodyBuilder.

pub fn structure(self, structure: impl Into<Structure>) -> BodyBuilder

Adds a Structure to the body.

Consumes self and returns a new BodyBuilder.

pub fn structures<I>(self, iter: I) -> BodyBuilder

where I: IntoIterator, I::Item: Into<Structure>,

Adds Structures to the body from an iterator.

Consumes self and returns a new BodyBuilder.

pub fn build(self) -> Body

Consumes self and builds the Body from the structures added via the builder methods.

Trait Implementations

impl Debug for BodyBuilder

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

Formats the value using the given formatter.

impl Default for BodyBuilder

fn default() -> BodyBuilder

Returns the “default value” for a type.

impl From<BodyBuilder> for Body

fn from(builder: BodyBuilder) -> Self

Converts to this type from the input type.