Struct hcl::structure::Block

source ·

pub struct Block {
    pub identifier: Identifier,
    pub labels: Vec<BlockLabel>,
    pub body: Body,
}

Expand description

Represents an HCL block which consists of a block identifier, zero or more block labels and a block body.

In HCL syntax this is represented as:

block_identifier "block_label1" "block_label2" {
  body
}

Fields

identifier: Identifier

The block identifier.

labels: Vec<BlockLabel>

Zero or more block labels.

body: Body

Represents the Block’s body.

Implementations

source

impl Block

source

pub fn new<I, L, B>(identifier: I, labels: L, body: B) -> Blockwhere
 I: Into<Identifier>,
 L: IntoIterator,
 L::Item: Into<BlockLabel>,
 B: IntoIterator,
 B::Item: Into<Structure>,

Creates a new Block from a block identifier, block labels and a block body.

source

pub fn builder(identifier: I) -> BlockBuilderwhere
I: Into<Identifier>,

Creates a new BlockBuilder to start building a new Block with the provided identifier.

source

pub fn identifier(&self) -> &str

Returns a reference to the block’s identifier.

source

pub fn labels(&self) -> &[BlockLabel]

Returns a reference to the block’s labels.

source

pub fn body(&self) -> &Body

Returns a reference to the block’s body.

Trait Implementations

source

impl Clone for Block

source

fn clone(&self) -> Block

Returns a copy of the value. Read more

1.0.0 · source

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

Performs copy-assignment from source. Read more

source

impl Debug for Block

source

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

Formats the value using the given formatter. Read more

source

impl<'de> Deserialize<'de> for Block

source

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
__D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more

source

impl Evaluate for Block

type Output = Block

The type that is returned by evaluate on success.

source

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. Read more

source

impl Format for Block

source

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. Read more

source

impl<I, B> From<(I, B)> for Blockwhere
I: Into<Identifier>,
B: Into<Body>,

source

fn from((ident, body): (I, B)) -> Block

Converts to this type from the input type.

source

impl From<Block> for Structure

source

fn from(block: Block) -> Structure

Converts to this type from the input type.

source

impl From<Block> for Value

source

fn from(block: Block) -> Value

Converts to this type from the input type.

source

impl<'de> IntoDeserializer<'de, Error> for Block

type Deserializer = MapAccessDeserializer<BlockAccess>

The type of the deserializer being converted into.

source

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

source

impl PartialEq<Block> for Block

source

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

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

1.0.0 · source

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. Read more

source

impl Serialize for Block

source

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

Serialize this value into the given Serde serializer. Read more

source

impl Eq for Block

source

impl StructuralEq for Block

source

impl StructuralPartialEq for Block

Auto Trait Implementations

impl RefUnwindSafe for Block

impl Send for Block

impl Sync for Block

impl Unpin for Block

impl UnwindSafe for Block

Blanket Implementations

source

impl<T> Any for Twhere
T: 'static + ?Sized,

source

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more

source

impl<T> Borrow<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

const: unstable · source

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more

source

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

source

fn equivalent(&self, key: &K) -> bool

Compare self to key and return true if they are equal.

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

impl<T, U> Into for Twhere
U: From<T>,

const: unstable · source

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source

impl<T> ToOwned for Twhere
T: Clone,

type Owned = T

The resulting type after obtaining ownership.

source

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more

source

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more

source

impl<T, U> TryFrom for Twhere
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

fn try_from(value: U) -> Result<T, <T as TryFrom>::Error>

Performs the conversion.

source

impl<T, U> TryInto for Twhere
U: TryFrom<T>,

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

fn try_into(self) -> Result<U, >::Error>

Performs the conversion.

source

Struct hcl::structure::Block

Fields

Implementations

impl Block

pub fn new<I, L, B>(identifier: I, labels: L, body: B) -> Blockwhere I: Into<Identifier>, L: IntoIterator, L::Item: Into<BlockLabel>, B: IntoIterator, B::Item: Into<Structure>,

pub fn builder<I>(identifier: I) -> BlockBuilderwhere I: Into<Identifier>,

pub fn identifier(&self) -> &str

pub fn labels(&self) -> &[BlockLabel]

pub fn body(&self) -> &Body

Trait Implementations

impl Clone for Block

fn clone(&self) -> Block

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

impl Debug for Block

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

impl<'de> Deserialize<'de> for Block

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>where __D: Deserializer<'de>,

impl Evaluate for Block

type Output = Block

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

impl Format for Block

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

impl<I, B> From<(I, B)> for Blockwhere I: Into<Identifier>, B: Into<Body>,

fn from((ident, body): (I, B)) -> Block

impl From<Block> for Structure

fn from(block: Block) -> Structure

impl From<Block> for Value

fn from(block: Block) -> Value

impl<'de> IntoDeserializer<'de, Error> for Block

type Deserializer = MapAccessDeserializer<BlockAccess>

fn into_deserializer(self) -> Self::Deserializer

impl PartialEq<Block> for Block

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

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

impl Serialize for Block

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

impl Eq for Block

impl StructuralEq for Block

impl StructuralPartialEq for Block

Auto Trait Implementations

impl RefUnwindSafe for Block

impl Send for Block

impl Sync for Block

impl Unpin for Block

impl UnwindSafe for Block

Blanket Implementations

impl<T> Any for Twhere T: 'static + ?Sized,

fn type_id(&self) -> TypeId

impl<T> Borrow<T> for Twhere T: ?Sized,

fn borrow(&self) -> &T

impl<T> BorrowMut<T> for Twhere T: ?Sized,

fn borrow_mut(&mut self) -> &mut T

impl<Q, K> Equivalent<K> for Qwhere Q: Eq + ?Sized, K: Borrow<Q> + ?Sized,

fn equivalent(&self, key: &K) -> bool

impl<T> From<T> for T

fn from(t: T) -> T

impl<T, U> Into<U> for Twhere U: From<T>,

fn into(self) -> U

impl<T> ToOwned for Twhere T: Clone,

type Owned = T

fn to_owned(&self) -> T

fn clone_into(&self, target: &mut T)

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

type Error = Infallible

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

type Error = <U as TryFrom<T>>::Error

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

impl<T> DeserializeOwned for Twhere T: for<'de> Deserialize<'de>,

pub fn new<I, L, B>(identifier: I, labels: L, body: B) -> Blockwhere
I: Into<Identifier>,
L: IntoIterator,
L::Item: Into<BlockLabel>,
B: IntoIterator,
B::Item: Into<Structure>,

pub fn builder<I>(identifier: I) -> BlockBuilderwhere
I: Into<Identifier>,

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>where
__D: Deserializer<'de>,

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

impl<I, B> From<(I, B)> for Blockwhere
I: Into<Identifier>,
B: Into<Body>,

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

impl<T> Any for Twhere
T: 'static + ?Sized,

impl<T> Borrow<T> for Twhere
T: ?Sized,

impl<T> BorrowMut<T> for Twhere
T: ?Sized,

impl<Q, K> Equivalent<K> for Qwhere
Q: Eq + ?Sized,
K: Borrow<Q> + ?Sized,

impl<T, U> Into<U> for Twhere
U: From<T>,

impl<T> ToOwned for Twhere
T: Clone,

impl<T, U> TryFrom<U> for Twhere
U: Into<T>,

impl<T, U> TryInto<U> for Twhere
U: TryFrom<T>,

impl<T> DeserializeOwned for Twhere
T: for<'de> Deserialize<'de>,