hcl/structure/body.rs
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 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
//! Types to represent and build HCL body structures.
use super::iter::{
Attributes, AttributesMut, Blocks, BlocksMut, IntoAttributes, IntoBlocks, Iter, IterMut,
};
use super::ser::BodySerializer;
use super::{Attribute, Block, Structure};
use crate::ser::with_internal_serialization;
use crate::Result;
use serde::{Deserialize, Serialize};
/// Represents an HCL config file body.
///
/// A `Body` consists of zero or more [`Attribute`] and [`Block`] HCL structures.
#[derive(Deserialize, Serialize, Debug, PartialEq, Eq, Default, Clone)]
#[serde(rename = "$hcl::Body")]
pub struct Body(pub Vec<Structure>);
impl Body {
#[doc(hidden)]
pub fn from_serializable<T>(value: &T) -> Result<Body>
where
T: ?Sized + Serialize,
{
with_internal_serialization(|| value.serialize(BodySerializer))
}
/// Consumes `self` and returns the wrapped `Vec<Structure>`.
pub fn into_inner(self) -> Vec<Structure> {
self.0
}
/// Creates a new [`BodyBuilder`] to start building a new `Body`.
pub fn builder() -> BodyBuilder {
BodyBuilder::default()
}
/// An iterator visiting all structures within the `Body`. The iterator element type is `&'a
/// Structure`.
///
/// # Examples
///
/// ```
/// use hcl::{Attribute, Body};
///
/// let body = Body::from([
/// Attribute::new("a", 1),
/// Attribute::new("b", 2),
/// Attribute::new("c", 3),
/// ]);
///
/// for structure in body.iter() {
/// println!("{structure:?}");
/// }
/// ```
pub fn iter(&self) -> Iter<'_> {
Iter::new(self)
}
/// An iterator visiting all structures within the `Body`. The iterator element type is `&'a
/// mut Structure`.
///
/// # Examples
///
/// ```
/// use hcl::{Attribute, Block, Body, Identifier, Structure};
///
/// let mut body = Body::from([
/// Structure::Attribute(Attribute::new("a", 1)),
/// Structure::Block(Block::new("b")),
/// Structure::Attribute(Attribute::new("c", 3)),
/// ]);
///
/// // Update all attribute keys and block identifiers
/// for structure in body.iter_mut() {
/// match structure {
/// Structure::Attribute(attr) => {
/// attr.key = Identifier::new(format!("attr_{}", attr.key)).unwrap();
/// }
/// Structure::Block(block) => {
/// block.identifier = Identifier::new(format!("block_{}", block.identifier)).unwrap();
/// }
/// }
/// }
///
/// assert_eq!(body.into_inner(), [
/// Structure::Attribute(Attribute::new("attr_a", 1)),
/// Structure::Block(Block::new("block_b")),
/// Structure::Attribute(Attribute::new("attr_c", 3)),
/// ]);
/// ```
pub fn iter_mut(&mut self) -> IterMut<'_> {
IterMut::new(self)
}
/// An iterator visiting all attributes within the `Body`. The iterator element type is `&'a
/// Attribute`.
///
/// # Examples
///
/// ```
/// use hcl::{Attribute, Block, Body, Structure};
///
/// let body = Body::from([
/// Structure::Attribute(Attribute::new("a", 1)),
/// Structure::Block(Block::new("b")),
/// Structure::Attribute(Attribute::new("c", 3)),
/// ]);
///
/// let vec: Vec<&Attribute> = body.attributes().collect();
/// assert_eq!(vec, [&Attribute::new("a", 1), &Attribute::new("c", 3)]);
/// ```
pub fn attributes(&self) -> Attributes<'_> {
Attributes::new(self)
}
/// An iterator visiting all attributes within the `Body`. The iterator element type is `&'a
/// mut Attribute`.
///
/// # Examples
///
/// ```
/// use hcl::{Attribute, Block, Body, Identifier, Structure};
///
/// let mut body = Body::from([
/// Structure::Attribute(Attribute::new("a", 1)),
/// Structure::Block(Block::new("b")),
/// Structure::Attribute(Attribute::new("c", 3)),
/// ]);
///
/// // Update all attribute keys
/// for attr in body.attributes_mut() {
/// attr.key = Identifier::new(format!("attr_{}", attr.key)).unwrap();
/// }
///
/// assert_eq!(body.into_inner(), [
/// Structure::Attribute(Attribute::new("attr_a", 1)),
/// Structure::Block(Block::new("b")),
/// Structure::Attribute(Attribute::new("attr_c", 3)),
/// ]);
/// ```
pub fn attributes_mut(&mut self) -> AttributesMut<'_> {
AttributesMut::new(self)
}
/// Creates a consuming iterator visiting all attributes within the `Body`. The object cannot
/// be used after calling this. The iterator element type is `Attribute`.
///
/// # Examples
///
/// ```
/// use hcl::{Attribute, Block, Body, Structure};
///
/// let body = Body::from([
/// Structure::Attribute(Attribute::new("a", 1)),
/// Structure::Block(Block::new("b")),
/// Structure::Attribute(Attribute::new("c", 3)),
/// ]);
///
/// let vec: Vec<Attribute> = body.into_attributes().collect();
/// assert_eq!(vec, [Attribute::new("a", 1), Attribute::new("c", 3)]);
/// ```
pub fn into_attributes(self) -> IntoAttributes {
IntoAttributes::new(self)
}
/// An iterator visiting all blocks within the `Body`. The iterator element type is `&'a
/// Block`.
///
/// # Examples
///
/// ```
/// use hcl::{Attribute, Block, Body, Structure};
///
/// let body = Body::from([
/// Structure::Attribute(Attribute::new("a", 1)),
/// Structure::Block(Block::new("b")),
/// Structure::Attribute(Attribute::new("c", 3)),
/// ]);
///
/// let vec: Vec<&Block> = body.blocks().collect();
/// assert_eq!(vec, [&Block::new("b")]);
/// ```
pub fn blocks(&self) -> Blocks<'_> {
Blocks::new(self)
}
/// An iterator visiting all blocks within the `Body`. The iterator element type is `&'a mut
/// Block`.
///
/// # Examples
///
/// ```
/// use hcl::{Attribute, Block, Body, Identifier, Structure};
///
/// let mut body = Body::from([
/// Structure::Attribute(Attribute::new("a", 1)),
/// Structure::Block(Block::new("b")),
/// Structure::Attribute(Attribute::new("c", 3)),
/// ]);
///
/// // Update all block identifiers
/// for block in body.blocks_mut() {
/// block.identifier = Identifier::new(format!("block_{}", block.identifier)).unwrap();
/// }
///
/// assert_eq!(body.into_inner(), [
/// Structure::Attribute(Attribute::new("a", 1)),
/// Structure::Block(Block::new("block_b")),
/// Structure::Attribute(Attribute::new("c", 3)),
/// ]);
/// ```
pub fn blocks_mut(&mut self) -> BlocksMut<'_> {
BlocksMut::new(self)
}
/// Creates a consuming iterator visiting all blocks within the `Body`. The object cannot
/// be used after calling this. The iterator element type is `Block`.
///
/// # Examples
///
/// ```
/// use hcl::{Attribute, Block, Body, Structure};
///
/// let body = Body::from([
/// Structure::Attribute(Attribute::new("a", 1)),
/// Structure::Block(Block::new("b")),
/// Structure::Attribute(Attribute::new("c", 3)),
/// ]);
///
/// let vec: Vec<Block> = body.into_blocks().collect();
/// assert_eq!(vec, [Block::new("b")]);
/// ```
pub fn into_blocks(self) -> IntoBlocks {
IntoBlocks::new(self)
}
}
impl<T> From<T> for Body
where
T: Into<Structure>,
{
fn from(value: T) -> Body {
Body(vec![value.into()])
}
}
impl<T> From<Vec<T>> for Body
where
T: Into<Structure>,
{
fn from(vec: Vec<T>) -> Self {
Body::from_iter(vec)
}
}
impl<T> From<&[T]> for Body
where
T: Clone + Into<Structure>,
{
fn from(slice: &[T]) -> Self {
Body::from_iter(slice.to_vec())
}
}
impl<T> From<&mut [T]> for Body
where
T: Clone + Into<Structure>,
{
fn from(slice: &mut [T]) -> Self {
Body::from_iter(slice.to_vec())
}
}
impl<T, const N: usize> From<[T; N]> for Body
where
T: Into<Structure>,
{
fn from(arr: [T; N]) -> Self {
Body::from_iter(arr)
}
}
/// `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()`](BodyBuilder::build) produces the final `Body`.
///
/// ## Example
///
/// ```
/// use hcl::{Body, Block};
///
/// let body = Body::builder()
/// .add_block(
/// Block::builder("resource")
/// .add_label("aws_s3_bucket")
/// .add_label("mybucket")
/// .add_attribute(("name", "mybucket"))
/// .build()
/// )
/// .build();
/// ```
#[derive(Debug, Default)]
pub struct BodyBuilder(Vec<Structure>);
impl BodyBuilder {
/// Adds an `Attribute` to the body.
///
/// Consumes `self` and returns a new `BodyBuilder`.
pub fn add_attribute<A>(self, attr: A) -> BodyBuilder
where
A: Into<Attribute>,
{
self.add_structure(attr.into())
}
/// Adds `Attribute`s to the body from an iterator.
///
/// Consumes `self` and returns a new `BodyBuilder`.
pub fn add_attributes<I>(self, iter: I) -> BodyBuilder
where
I: IntoIterator,
I::Item: Into<Attribute>,
{
self.add_structures(iter.into_iter().map(Into::into))
}
/// Adds a `Block` to the body.
///
/// Consumes `self` and returns a new `BodyBuilder`.
pub fn add_block<B>(self, block: B) -> BodyBuilder
where
B: Into<Block>,
{
self.add_structure(block.into())
}
/// Adds `Block`s to the body from an iterator.
///
/// Consumes `self` and returns a new `BodyBuilder`.
pub fn add_blocks<I>(self, iter: I) -> BodyBuilder
where
I: IntoIterator,
I::Item: Into<Block>,
{
self.add_structures(iter.into_iter().map(Into::into))
}
/// Adds a `Structure` to the body.
///
/// Consumes `self` and returns a new `BodyBuilder`.
pub fn add_structure<S>(mut self, structure: S) -> BodyBuilder
where
S: Into<Structure>,
{
self.0.push(structure.into());
self
}
/// Adds `Structure`s to the body from an iterator.
///
/// Consumes `self` and returns a new `BodyBuilder`.
pub fn add_structures<I>(mut self, iter: I) -> BodyBuilder
where
I: IntoIterator,
I::Item: Into<Structure>,
{
self.0.extend(iter.into_iter().map(Into::into));
self
}
/// Consumes `self` and builds the [`Body`] from the structures added via the builder methods.
pub fn build(self) -> Body {
Body::from_iter(self.0)
}
}