Struct avocado::dsl::doc::Document

pub struct Document<T>(_);

A top-level DSL document consisting of multiple path => sub-operation specifiers and respecting the order of insertion during iteration.

Methods

impl<T> Document<T>

pub fn new() -> Self

Creates an empty document.

pub fn with_capacity(capacity: usize) -> Self

Creates an empty document with the specified capacity.

pub fn capacity(&self) -> usize

Returns the current capacity of the document.

pub fn len(&self) -> usize

Returns the number of entries (key-value pairs) in the document.

pub fn is_empty(&self) -> bool

Returns true if and only if the document contains no entries.

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

Reserves additional capacity for the document.

pub fn insert(&mut self, key: Cow<'static, str>, value: T) -> Option<T>

Inserts a key and a value into the document. If the key already exists, returns the previous value associated with it.

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

Returns true if and only if the document contains the specified key.

pub fn get(&self, key: &str) -> Option<&T>

Returns a reference to the subquery associated with the key.

pub fn get_mut(&mut self, key: &str) -> Option<&mut T>

Returns a mutable reference to the subquery associated with the key.

pub fn remove(&mut self, key: &str) -> Option<T>

Removes the subquery associated with the key and returns it.

pub fn clear(&mut self)

Removes all key-value pairs, leaving the document in an empty state.

Trait Implementations

impl<T: PartialOrd> PartialOrd<Document<T>> for Document<T>

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

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

fn lt(&self, other: &Document<T>) -> bool

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

fn le(&self, other: &Document<T>) -> bool

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

fn gt(&self, other: &Document<T>) -> bool

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

fn ge(&self, other: &Document<T>) -> bool

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

impl<T> Default for Document<T>

fn default() -> Self

Returns the "default value" for a type.

impl<T: Ord> Ord for Document<T>

fn cmp(&self, other: &Document<T>) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

Compares and returns the minimum of two values.

impl<T: PartialEq> PartialEq<Document<T>> for Document<T>

fn eq(&self, other: &Document<T>) -> bool

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

fn ne(&self, other: &Document<T>) -> bool

This method tests for !=.

impl From<Document<Filter>> for Filter

Filter::from(FilterDoc) yields a Filter::Doc(...).

fn from(doc: FilterDoc) -> Self

Performs the conversion.

impl<T: Clone> Clone for Document<T>

fn clone(&self) -> Document<T>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> IntoIterator for Document<T>

type Item = (Cow<'static, str>, T)

The type of the elements being iterated over.

type IntoIter = IntoIter<T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a Document<T>

type Item = (&'a str, &'a T)

The type of the elements being iterated over.

type IntoIter = Iter<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a, T> IntoIterator for &'a mut Document<T>

type Item = (&'a str, &'a mut T)

The type of the elements being iterated over.

type IntoIter = IterMut<'a, T>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<T, K, V> Extend<(K, V)> for Document<T> where     K: Into<Cow<'static, str>>,     V: Into<T>,

fn extend<I: IntoIterator<Item = (K, V)>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

impl<T: Eq> Eq for Document<T>

impl<T: Debug> Debug for Document<T>

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

Formats the value using the given formatter.

impl<T: Hash> Hash for Document<T>

fn hash<__HT: Hasher>(&self, state: &mut __HT)

Feeds this value into the given [Hasher].

fn hash_slice<H>(data: &[Self], state: &mut H) where     H: Hasher,

Feeds a slice of this type into the given [Hasher].

impl<T, K, V> FromIterator<(K, V)> for Document<T> where     K: Into<Cow<'static, str>>,     V: Into<T>,

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

Creates a value from an iterator.

impl<'de, T> Deserialize<'de> for Document<T> where     T: Deserialize<'de>,

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

Deserialize this value from the given Serde deserializer.

impl<T> Serialize for Document<T> where     T: Serialize,

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

Serialize this value into the given Serde serializer.