Struct Document

pub struct Document { /* private fields */ }

The bson document.

Since bson in litedb uses case-insensitive key comparison, this implementation does so.

Implementations

impl Document

pub fn new() -> Document

pub fn with_capacity(capacity: usize) -> Document

pub fn insert(&mut self, key: impl Into<String>, value: impl Into<Value>)

Adds value to document.

Panics

This function will panic if the key contains null char ('\0')

pub fn try_get(&self, key: impl AsRef<str>) -> Option<&Value>

Gets the value with key, or None if not exists

pub fn get(&self, key: impl AsRef<str>) -> &Value

Gets the value with key.

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

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

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

pub fn is_empty(&self) -> bool

pub fn len(&self) -> usize

pub fn iter(&self) -> impl Iterator<Item = (&str, &Value)> + Clone

pub fn clear(&mut self)

pub fn entry(&mut self, key: impl Into<String>) -> Entry<'_>

impl Document

pub fn get_serialized_value_len(&self) -> usize

Returns the size of serialized value.

This doesn’t include tag or name of key.

pub fn write_value<W: BsonWriter>( &self, w: &mut W, ) -> Result<(), <W as BsonWriter>::Error>

Writes the value to the BsonWriter

pub fn parse_document<R: BsonReader>( r: &mut R, ) -> Result<Document, <R as BsonReader>::Error>

Parses the document

Trait Implementations

impl Clone for Document

fn clone(&self) -> Document

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Document

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

Formats the value using the given formatter.

impl Default for Document

fn default() -> Self

Returns the “default value” for a type.

impl From<Document> for Value

fn from(v: Document) -> Value

Converts to this type from the input type.

impl Index<&str> for Document

type Output = Value

The returned type after indexing.

fn index(&self, index: &str) -> &Self::Output

Performs the indexing (container[index]) operation.

impl PartialEq for Document

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Document