Enum liquid_value::Value

pub enum Value {
    Scalar(Scalar),
    Array(Array),
    Object(Object),
    Nil,
    Empty,
    Blank,
}

An enum to represent different value types

Variants

Scalar(Scalar)

A scalar value.

Array(Array)

A sequence of Values.

Object(Object)

A sequence of key/Value pairs.

Nil

Nothing.

Empty

No content.

Blank

Evaluates to empty string.

Methods

impl Value

pub fn scalar<T: Into<Scalar>>(value: T) -> Self

Create as a Scalar.

pub fn array<I: IntoIterator<Item = Self>>(iter: I) -> Self

Create as an Array.

pub fn nil() -> Self

Create as nothing.

pub fn source(&self) -> ValueSource

A Display for a Scalar as source code.

pub fn render(&self) -> ValueRendered

A Display for a Value rendered for the user.

pub fn to_str(&self) -> Cow<str>

Interpret as a string.

pub fn as_scalar(&self) -> Option<&Scalar>

Extracts the scalar value if it is a scalar.

pub fn into_scalar(self) -> Option<Scalar>

Extracts the scalar value if it is a scalar.

pub fn is_scalar(&self) -> bool

Tests whether this value is a scalar

pub fn as_array(&self) -> Option<&Array>

Extracts the array value if it is an array.

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

Extracts the array value if it is an array.

pub fn into_array(self) -> Option<Array>

Extracts the array value if it is an array.

pub fn is_array(&self) -> bool

Tests whether this value is an array

pub fn as_object(&self) -> Option<&Object>

Extracts the object value if it is a object.

pub fn as_object_mut(&mut self) -> Option<&mut Object>

Extracts the object value if it is a object.

pub fn into_object(self) -> Option<Object>

Extracts the object value if it is a object.

pub fn is_object(&self) -> bool

Tests whether this value is an object

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

Extracts the nil value if it is nil

pub fn is_nil(&self) -> bool

Tests whether this value is nil

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

Extracts the empty value if it is empty

pub fn is_empty(&self) -> bool

Tests whether this value is empty

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

Extracts the blank value if it is blank

pub fn is_blank(&self) -> bool

Tests whether this value is blank

pub fn is_truthy(&self) -> bool

Evaluate using Liquid "truthiness"

pub fn is_default(&self) -> bool

Whether a default constructed value.

pub fn type_name(&self) -> &'static str

Report the data type (generally for error reporting).

pub fn contains_key(&self, index: &Scalar) -> bool

Access a contained Value.

Important traits for Keys

impl Iterator for Keys type Item = Scalar;

pub fn keys(&self) -> Keys

Keys available for lookup.

pub fn get<'s>(&'s self, index: &ScalarCow) -> Option<&'s Self>

Access a contained Value.

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 Default for Value

fn default() -> Self

Returns the "default value" for a type.

impl Eq for Value

impl PartialEq<Value> for Value

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl PartialOrd<Value> for Value

fn partial_cmp(&self, other: &Self) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

#[must_use] fn lt(&self, other: &Rhs) -> bool

This method tests less than (for self and other) and is used by the < operator.

#[must_use] fn le(&self, other: &Rhs) -> bool

This method tests less than or equal to (for self and other) and is used by the <= operator.

#[must_use] fn gt(&self, other: &Rhs) -> bool

This method tests greater than (for self and other) and is used by the > operator.

#[must_use] fn ge(&self, other: &Rhs) -> bool

This method tests greater than or equal to (for self and other) and is used by the >= operator.

impl Debug for Value

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

Formats the value using the given formatter.

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<'de> Deserialize<'de> for Value

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

Deserialize this value from the given Serde deserializer.