Struct liquid_core::Object

pub struct Object { /* fields omitted */ }

Type representing a Liquid object, payload of the Value::Object variant

Implementations

impl Object

pub fn new() -> Self

Makes a new empty Object.

pub fn clear(&mut self)

Clears the map, removing all values.

pub fn get<Q: ?Sized>(&self, key: &Q) -> Option<&Value> where
    KString: Borrow<Q>,
    Q: Ord + Eq + Hash, 

Returns a reference to the value corresponding to the key.

The key may be any borrowed form of the map's key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn contains_key<Q: ?Sized>(&self, key: &Q) -> bool where
    KString: Borrow<Q>,
    Q: Ord + Eq + Hash, 

Returns true if the map contains a value for the specified key.

The key may be any borrowed form of the map's key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn get_mut<Q: ?Sized>(&mut self, key: &Q) -> Option<&mut Value> where
    KString: Borrow<Q>,
    Q: Ord + Eq + Hash, 

Returns a mutable reference to the value corresponding to the key.

The key may be any borrowed form of the map's key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn insert(&mut self, k: KString, v: Value) -> Option<Value>

Inserts a key-value pair into the map.

If the map did not have this key present, None is returned.

If the map did have this key present, the value is updated, and the old value is returned.

pub fn remove<Q: ?Sized>(&mut self, key: &Q) -> Option<Value> where
    KString: Borrow<Q>,
    Q: Ord + Eq + Hash, 

Removes a key from the map, returning the value at the key if the key was previously in the map.

The key may be any borrowed form of the map's key type, but the ordering on the borrowed form must match the ordering on the key type.

pub fn entry<S>(&mut self, key: S) -> Entry<'_> where
    S: Into<KString>, 

Gets the given key's corresponding entry in the map for in-place manipulation.

pub fn len(&self) -> usize

Returns the number of elements in the map.

pub fn is_empty(&self) -> bool

Returns true if the map contains no elements.

pub fn iter(&self) -> Iter<'_>

Gets an iterator over the entries of the map.

pub fn iter_mut(&mut self) -> IterMut<'_>

Gets a mutable iterator over the entries of the map.

pub fn keys(&self) -> Keys<'_>

Gets an iterator over the keys of the map.

pub fn values(&self) -> Values<'_>

Gets an iterator over the values of the map.

pub fn values_mut(&mut self) -> ValuesMut<'_>

Gets an iterator over mutable values of the map.

Trait Implementations

impl Clone for Object

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Object

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

Formats the value using the given formatter.

impl Default for Object

fn default() -> Self

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for Object

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

Deserialize this value from the given Serde deserializer.

impl Eq for Object

impl Extend<(KString, Value)> for Object

fn extend<T>(&mut self, iter: T) where
    T: IntoIterator<Item = (KString, Value)>, 

Extends a collection with the contents of an iterator.

pub fn extend_one(&mut self, item: A)

🔬 This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

pub fn extend_reserve(&mut self, additional: usize)

🔬 This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<Object> for ValueCow<'static>

fn from(other: Object) -> Self

Performs the conversion.

impl From<Object> for Value

fn from(other: Object) -> Self

Performs the conversion.

impl FromIterator<(KString, Value)> for Object

fn from_iter<T>(iter: T) -> Self where
    T: IntoIterator<Item = (KString, Value)>, 

Creates a value from an iterator.

impl<'a, Q: ?Sized> Index<&'a Q> for Object where
    KString: Borrow<Q>,
    Q: Ord + Eq + Hash, 

Access an element of this map. Panics if the given key is not present in the map.

match *val {
    Value::Scalar(ref s) => Some(s.to_kstr()),
    Value::Array(ref arr) => Some(arr[0].to_kstr()),
    Value::Object(ref map) => Some(map["type"].to_kstr()),
    _ => None,
}

type Output = Value

The returned type after indexing.

fn index(&self, index: &Q) -> &Value

Performs the indexing (container[index]) operation.

impl<'a, Q: ?Sized> IndexMut<&'a Q> for Object where
    KString: Borrow<Q>,
    Q: Ord + Eq + Hash, 

Mutably access an element of this map. Panics if the given key is not present in the map.

map["key"] = liquid_core::value!("value");

fn index_mut(&mut self, index: &Q) -> &mut Value

Performs the mutable indexing (container[index]) operation.

impl<'a> IntoIterator for &'a Object

type Item = (&'a KString, &'a Value)

The type of the elements being iterated over.

type IntoIter = Iter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a mut Object

type Item = (&'a KString, &'a mut Value)

The type of the elements being iterated over.

type IntoIter = IterMut<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl IntoIterator for Object

type Item = (KString, Value)

The type of the elements being iterated over.

type IntoIter = IntoIter

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl ObjectView for Object

fn as_value(&self) -> &dyn ValueView

Cast to ValueView

fn size(&self) -> i64

Returns the number of elements.

fn keys<'k>(&'k self) -> Box<dyn Iterator<Item = KStringCow<'k>> + 'k>

Keys available for lookup.

fn values<'k>(&'k self) -> Box<dyn Iterator<Item = &'k dyn ValueView> + 'k>

Keys available for lookup.

fn iter<'k>(
    &'k self
) -> Box<dyn Iterator<Item = (KStringCow<'k>, &'k dyn ValueView)> + 'k>

Returns an iterator .

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

Access a contained BoxedValue.

fn get<'s>(&'s self, index: &str) -> Option<&'s dyn ValueView>

Access a contained Value.

impl PartialEq<Object> for Object

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

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

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

This method tests for !=.

impl Serialize for Object

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

Serialize this value into the given Serde serializer.

impl ValueView for Object

fn as_debug(&self) -> &dyn Debug

Get a Debug representation

fn render(&self) -> DisplayCow<'_>

A Display for a BoxedValue rendered for the user.

fn source(&self) -> DisplayCow<'_>

A Display for a Value as source code.

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

Report the data type (generally for error reporting).

fn query_state(&self, state: State) -> bool

Query the value's state

fn to_kstr(&self) -> KStringCow<'_>

Interpret as a string.

fn to_value(&self) -> Value

Convert to an owned type.

fn as_object(&self) -> Option<&dyn ObjectView>

Extracts the object value if it is a object.

fn as_scalar(&self) -> Option<ScalarCow<'_>>

Extracts the scalar value if it is a scalar.

fn is_scalar(&self) -> bool

Tests whether this value is a scalar

fn as_array(&self) -> Option<&dyn ArrayView>

Extracts the array value if it is an array.

fn is_array(&self) -> bool

Tests whether this value is an array

fn is_object(&self) -> bool

Tests whether this value is an object

fn as_state(&self) -> Option<State>

Extracts the state if it is one

fn is_state(&self) -> bool

Tests whether this value is state

fn is_nil(&self) -> bool

Tests whether this value is nil