Struct mongodb_cwal::ordered::OrderedDocument

pub struct OrderedDocument { /* fields omitted */ }

A BSON document represented as an associative HashMap with insertion ordering.

Implementations

impl OrderedDocument

pub fn new() -> OrderedDocument

Creates a new empty OrderedDocument.

pub fn iter(&self) -> OrderedDocumentIterator

Gets an iterator over the entries of the map.

pub fn clear(&mut self)

Clears the document, removing all values.

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

Returns a reference to the Bson corresponding to the key.

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

Gets a mutable reference to the Bson corresponding to the key

pub fn get_f64(&self, key: &str) -> Result<f64, ValueAccessError>

Get a floating point value for this key if it exists and has the correct type.

pub fn get_f64_mut(&mut self, key: &str) -> Result<&mut f64, ValueAccessError>

Get a mutable reference to a floating point value for this key if it exists and has the correct type.

pub fn get_str(&self, key: &str) -> Result<&str, ValueAccessError>

Get a string slice this key if it exists and has the correct type.

pub fn get_str_mut(&mut self, key: &str) -> Result<&mut str, ValueAccessError>

Get a mutable string slice this key if it exists and has the correct type.

pub fn get_array(&self, key: &str) -> Result<&Vec<Bson>, ValueAccessError>

Get a reference to an array for this key if it exists and has the correct type.

pub fn get_array_mut(
    &mut self,
    key: &str
) -> Result<&mut Vec<Bson>, ValueAccessError>

Get a mutable reference to an array for this key if it exists and has the correct type.

pub fn get_document(
    &self,
    key: &str
) -> Result<&OrderedDocument, ValueAccessError>

Get a reference to a document for this key if it exists and has the correct type.

pub fn get_document_mut(
    &mut self,
    key: &str
) -> Result<&mut OrderedDocument, ValueAccessError>

Get a mutable reference to a document for this key if it exists and has the correct type.

pub fn get_bool(&self, key: &str) -> Result<bool, ValueAccessError>

Get a bool value for this key if it exists and has the correct type.

pub fn get_bool_mut(&mut self, key: &str) -> Result<&mut bool, ValueAccessError>

Get a mutable reference to a bool value for this key if it exists and has the correct type.

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

Returns wether this key has a null value

pub fn get_i32(&self, key: &str) -> Result<i32, ValueAccessError>

Get an i32 value for this key if it exists and has the correct type.

pub fn get_i32_mut(&mut self, key: &str) -> Result<&mut i32, ValueAccessError>

Get a mutable reference to an i32 value for this key if it exists and has the correct type.

pub fn get_i64(&self, key: &str) -> Result<i64, ValueAccessError>

Get an i64 value for this key if it exists and has the correct type.

pub fn get_i64_mut(&mut self, key: &str) -> Result<&mut i64, ValueAccessError>

Get a mutable reference to an i64 value for this key if it exists and has the correct type.

pub fn get_time_stamp(&self, key: &str) -> Result<i64, ValueAccessError>

Get a time stamp value for this key if it exists and has the correct type.

pub fn get_time_stamp_mut(
    &mut self,
    key: &str
) -> Result<&mut i64, ValueAccessError>

Get a mutable reference to a time stamp value for this key if it exists and has the correct type.

pub fn get_binary_generic(
    &self,
    key: &str
) -> Result<&Vec<u8>, ValueAccessError>

Get a reference to a generic binary value for this key if it exists and has the correct type.

pub fn get_binary_generic_mut(
    &mut self,
    key: &str
) -> Result<&mut Vec<u8>, ValueAccessError>

Get a mutable reference generic binary value for this key if it exists and has the correct type.

pub fn get_object_id(&self, key: &str) -> Result<&ObjectId, ValueAccessError>

Get a reference to an object id value for this key if it exists and has the correct type.

pub fn get_object_id_mut(
    &mut self,
    key: &str
) -> Result<&mut ObjectId, ValueAccessError>

Get a mutable reference to an object id value for this key if it exists and has the correct type.

pub fn get_utc_datetime(
    &self,
    key: &str
) -> Result<&DateTime<Utc>, ValueAccessError>

Get a reference to a UTC datetime value for this key if it exists and has the correct type.

pub fn get_utc_datetime_mut(
    &mut self,
    key: &str
) -> Result<&mut DateTime<Utc>, ValueAccessError>

Get a mutable reference to a UTC datetime value for this key if it exists and has the correct type.

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

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

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

Gets a collection of all keys in the document.

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

Gets a collection of all values in the document.

pub fn len(&self) -> usize

Returns the number of elements in the document.

pub fn is_empty(&self) -> bool

Returns true if the document contains no elements

pub fn insert<KT, BT>(&mut self, key: KT, val: BT) -> Option<Bson> where
    BT: Into<Bson>,
    KT: Into<String>, 

Sets the value of the entry with the OccupiedEntry's key, and returns the entry's old value. Accepts any type that can be converted into Bson.

pub fn insert_bson(&mut self, key: String, val: Bson) -> Option<Bson>

Sets the value of the entry with the OccupiedEntry's key, and returns the entry's old value.

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

Takes the value of the entry out of the document, and returns it.

pub fn entry(&mut self, k: String) -> Entry

Trait Implementations

impl Clone for OrderedDocument

fn clone(&self) -> OrderedDocument

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OrderedDocument

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

Formats the value using the given formatter.

impl Default for OrderedDocument

fn default() -> OrderedDocument

Returns the "default value" for a type.

impl<'de> Deserialize<'de> for OrderedDocument

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

Deserialize this value given this Deserializer.

impl Display for OrderedDocument

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

Formats the value using the given formatter.

impl Extend<(String, Bson)> for OrderedDocument

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

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

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

Extends a collection with exactly one element.

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<LinkedHashMap<String, Bson, RandomState>> for OrderedDocument

fn from(tree: LinkedHashMap<String, Bson, RandomState>) -> OrderedDocument

Performs the conversion.

impl From<OrderedDocument> for Bson

fn from(a: OrderedDocument) -> Bson

Performs the conversion.

impl FromIterator<(String, Bson)> for OrderedDocument

fn from_iter<T>(iter: T) -> OrderedDocument where
    T: IntoIterator<Item = (String, Bson)>, 

Creates a value from an iterator.

impl IntoIterator for OrderedDocument

type Item = (String, Bson)

The type of the elements being iterated over.

type IntoIter = OrderedDocumentIntoIterator

Which kind of iterator are we turning this into?

fn into_iter(self) -> <OrderedDocument as IntoIterator>::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for &'a OrderedDocument

type Item = (&'a String, &'a Bson)

The type of the elements being iterated over.

type IntoIter = OrderedDocumentIterator<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> <&'a OrderedDocument as IntoIterator>::IntoIter

Creates an iterator from a value.

impl PartialEq<OrderedDocument> for OrderedDocument

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

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

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

This method tests for !=.

impl Serialize for OrderedDocument

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for OrderedDocument