Enum hcl::Value

pub enum Value {
    Null,
    Bool(bool),
    Number(Number),
    String(String),
    Array(Vec<Value>),
    Object(Map<String, Value>),
}

Represents any valid HCL value.

Variants

Null

Represents a HCL null value.

Bool(bool)

Represents a HCL boolean.

Number(Number)

Represents a HCL number, either integer or float.

String(String)

Represents a HCL string.

Array(Vec<Value>)

Represents a HCL array.

Object(Map<String, Value>)

Represents a HCL object.

Implementations

impl Value

pub fn as_array(&self) -> Option<&Vec<Value>>

If the Value is an Array, returns the associated vector. Returns None otherwise.

pub fn as_array_mut(&mut self) -> Option<&mut Vec<Value>>

If the Value is an Array, returns the associated mutable vector. Returns None otherwise.

pub fn as_bool(&self) -> Option<bool>

If the Value is a Boolean, represent it as bool if possible. Returns None otherwise.

pub fn as_f64(&self) -> Option<f64>

If the Value is a Number, represent it as f64 if possible. Returns None otherwise.

pub fn as_i64(&self) -> Option<i64>

If the Value is a Number, represent it as i64 if possible. Returns None otherwise.

pub fn as_null(&self) -> Option<()>

If the Value is a Null, returns (). Returns None otherwise.

pub fn as_number(&self) -> Option<&Number>

If the Value is a Number, returns the associated Number. Returns None otherwise.

pub fn as_object(&self) -> Option<&Map<String, Value>>

If the Value is an Object, returns the associated Map. Returns None otherwise.

pub fn as_object_mut(&mut self) -> Option<&mut Map<String, Value>>

If the Value is an Object, returns the associated mutable Map. Returns None otherwise.

pub fn as_str(&self) -> Option<&str>

If the Value is a String, returns the associated str. Returns None otherwise.

pub fn as_u64(&self) -> Option<u64>

If the Value is a Number, represent it as u64 if possible. Returns None otherwise.

pub fn is_array(&self) -> bool

Returns true if the Value is an Array. Returns false otherwise.

For any Value on which is_array returns true, as_array and as_array_mut are guaranteed to return the vector representing the array.

pub fn is_boolean(&self) -> bool

Returns true if the Value is a Boolean. Returns false otherwise.

For any Value on which is_boolean returns true, as_bool is guaranteed to return the boolean value.

pub fn is_f64(&self) -> bool

Returns true if the Value is a number that can be represented by f64.

For any Value on which is_f64 returns true, as_f64 is guaranteed to return the floating point value.

pub fn is_i64(&self) -> bool

Returns true if the Value is an integer between i64::MIN and i64::MAX.

For any Value on which is_i64 returns true, as_i64 is guaranteed to return the integer value.

pub fn is_number(&self) -> bool

Returns true if the Value is a Number. Returns false otherwise.

pub fn is_null(&self) -> bool

Returns true if the Value is a Null. Returns false otherwise.

For any Value on which is_null returns true, as_null is guaranteed to return Some(()).

pub fn is_object(&self) -> bool

Returns true if the Value is an Object. Returns false otherwise.

For any Value on which is_object returns true, as_object and as_object_mut are guaranteed to return the map representation of the object.

pub fn is_string(&self) -> bool

Returns true if the Value is a String. Returns false otherwise.

For any Value on which is_string returns true, as_str is guaranteed to return the string slice.

pub fn is_u64(&self) -> bool

Returns true if the Value is an integer between zero and u64::MAX.

For any Value on which is_u64 returns true, as_u64 is guaranteed to return the integer value.

pub fn take(&mut self) -> Value

Takes the value out of the Value, leaving a Null in its place.

Trait Implementations

impl Clone for Value

fn clone(&self) -> Value

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Value

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

Formats the value using the given formatter.

impl Default for Value

fn default() -> Value

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Value

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for Value

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

Formats the value using the given formatter.

impl Format for Value

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<'a, T: Clone + Into<Value>> From<&'a [T]> for Value

fn from(f: &'a [T]) -> Self

Converts to this type from the input type.

impl From<&str> for Value

fn from(s: &str) -> Self

Converts to this type from the input type.

impl From<()> for Value

fn from((): ()) -> Self

Converts to this type from the input type.

impl From<Attribute> for Value

fn from(attr: Attribute) -> Value

Converts to this type from the input type.

impl<'a> From<Cow<'a, str>> for Value

fn from(s: Cow<'a, str>) -> Self

Converts to this type from the input type.

impl From<Expression> for Value

fn from(expr: Expression) -> Self

Converts to this type from the input type.

impl From<IndexMap<String, Value>> for Value

fn from(f: Map<String, Value>) -> Self

Converts to this type from the input type.

impl From<Number> for Value

fn from(num: Number) -> Self

Converts to this type from the input type.

impl From<ObjectKey> for Value

fn from(key: ObjectKey) -> Self

Converts to this type from the input type.

impl From<String> for Value

fn from(s: String) -> Self

Converts to this type from the input type.

impl From<Structure> for Value

fn from(s: Structure) -> Value

Converts to this type from the input type.

impl<T> From<T> for Value

where T: IntoJsonSpec,

fn from(value: T) -> Value

Converts to this type from the input type.

impl From<Value> for Expression

fn from(value: Value) -> Self

Converts to this type from the input type.

impl<T: Into<Value>> From<Vec<T>> for Value

fn from(f: Vec<T>) -> Self

Converts to this type from the input type.

impl From<bool> for Value

fn from(b: bool) -> Self

Converts to this type from the input type.

impl From<f32> for Value

fn from(f: f32) -> Self

Converts to this type from the input type.

impl From<f64> for Value

fn from(f: f64) -> Self

Converts to this type from the input type.

impl From<i16> for Value

fn from(n: i16) -> Self

Converts to this type from the input type.

impl From<i32> for Value

fn from(n: i32) -> Self

Converts to this type from the input type.

impl From<i64> for Value

fn from(n: i64) -> Self

Converts to this type from the input type.

impl From<i8> for Value

fn from(n: i8) -> Self

Converts to this type from the input type.

impl From<isize> for Value

fn from(n: isize) -> Self

Converts to this type from the input type.

impl From<u16> for Value

fn from(n: u16) -> Self

Converts to this type from the input type.

impl From<u32> for Value

fn from(n: u32) -> Self

Converts to this type from the input type.

impl From<u64> for Value

fn from(n: u64) -> Self

Converts to this type from the input type.

impl From<u8> for Value

fn from(n: u8) -> Self

Converts to this type from the input type.

impl From<usize> for Value

fn from(n: usize) -> Self

Converts to this type from the input type.

impl<K: Into<String>, V: Into<Value>> FromIterator<(K, V)> for Value

fn from_iter<I: IntoIterator<Item = (K, V)>>(iter: I) -> Self

Creates a value from an iterator.

impl<T: Into<Value>> FromIterator<T> for Value

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

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

type Deserializer = ValueDeserializer

The type of the deserializer being converted into.

fn into_deserializer(self) -> Self::Deserializer

Convert this value into a deserializer.

impl PartialEq for Value

fn eq(&self, other: &Value) -> 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 Value

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 Value

impl StructuralPartialEq for Value