Struct bson::RawArrayBuf

pub struct RawArrayBuf { /* private fields */ }

An owned BSON array value (akin to std::path::PathBuf), backed by a buffer of raw BSON bytes. This type can be used to construct owned array values, which can be used to append to RawDocumentBuf or as a field in a Deserialize struct.

Iterating over a RawArrayBuf yields either an error or a RawBson value that borrows from the original document without making any additional allocations.

use bson::raw::RawArrayBuf;

let mut array = RawArrayBuf::new();
array.push("a string");
array.push(12_i32);

let mut iter = array.into_iter();

let value = iter.next().unwrap()?;
assert_eq!(value.as_str(), Some("a string"));

let value = iter.next().unwrap()?;
assert_eq!(value.as_i32(), Some(12));

assert!(iter.next().is_none());

This type implements Deref to RawArray, meaning that all methods on RawArray are available on RawArrayBuf values as well. This includes RawArray::get or any of the type-specific getters, such as RawArray::get_object_id or RawArray::get_str. Note that accessing elements is an O(N) operation, as it requires iterating through the document from the beginning to find the requested key.

Implementations

impl RawArrayBuf

pub fn new() -> RawArrayBuf

Construct a new, empty RawArrayBuf.

pub fn push(&mut self, value: impl Into<RawBson>)

Append a value to the end of the array.

use bson::raw::{RawArrayBuf, RawDocumentBuf};

let mut array = RawArrayBuf::new();
array.push("a string");
array.push(12_i32);

let mut doc = RawDocumentBuf::new();
doc.append("a key", "a value");
array.push(doc.clone());

let mut iter = array.into_iter();

let value = iter.next().unwrap()?;
assert_eq!(value.as_str(), Some("a string"));

let value = iter.next().unwrap()?;
assert_eq!(value.as_i32(), Some(12));

let value = iter.next().unwrap()?;
assert_eq!(value.as_document(), Some(doc.as_ref()));

assert!(iter.next().is_none());

Methods from Deref<Target = RawArray>

pub fn to_raw_array_buf(&self) -> RawArrayBuf

Convert this borrowed RawArray into an owned RawArrayBuf.

This involves a traversal of the array to count the values.

pub fn get(&self, index: usize) -> Result<Option<RawBsonRef<'_>>>

Gets a reference to the value at the given index.

pub fn get_f64(&self, index: usize) -> ValueAccessResult<f64>

Gets the BSON double at the given index or returns an error if the value at that index isn’t a double.

pub fn get_str(&self, index: usize) -> ValueAccessResult<&str>

Gets a reference to the string at the given index or returns an error if the value at that index isn’t a string.

pub fn get_document(&self, index: usize) -> ValueAccessResult<&RawDocument>

Gets a reference to the document at the given index or returns an error if the value at that index isn’t a document.

pub fn get_array(&self, index: usize) -> ValueAccessResult<&RawArray>

Gets a reference to the array at the given index or returns an error if the value at that index isn’t a array.

pub fn get_binary(&self, index: usize) -> ValueAccessResult<RawBinaryRef<'_>>

Gets a reference to the BSON binary value at the given index or returns an error if the value at that index isn’t a binary.

pub fn get_object_id(&self, index: usize) -> ValueAccessResult<ObjectId>

Gets the ObjectId at the given index or returns an error if the value at that index isn’t an ObjectId.

pub fn get_bool(&self, index: usize) -> ValueAccessResult<bool>

Gets the boolean at the given index or returns an error if the value at that index isn’t a boolean.

pub fn get_datetime(&self, index: usize) -> ValueAccessResult<DateTime>

Gets the DateTime at the given index or returns an error if the value at that index isn’t a DateTime.

pub fn get_regex(&self, index: usize) -> ValueAccessResult<RawRegexRef<'_>>

Gets a reference to the BSON regex at the given index or returns an error if the value at that index isn’t a regex.

pub fn get_timestamp(&self, index: usize) -> ValueAccessResult<Timestamp>

Gets a reference to the BSON timestamp at the given index or returns an error if the value at that index isn’t a timestamp.

pub fn get_i32(&self, index: usize) -> ValueAccessResult<i32>

Gets the BSON int32 at the given index or returns an error if the value at that index isn’t a 32-bit integer.

pub fn get_i64(&self, index: usize) -> ValueAccessResult<i64>

Gets BSON int64 at the given index or returns an error if the value at that index isn’t a 64-bit integer.

pub fn as_bytes(&self) -> &[u8]

Gets a reference to the raw bytes of the RawArray.

pub fn is_empty(&self) -> bool

Whether this array contains any elements or not.

Trait Implementations

impl AsRef<RawArray> for RawArrayBuf

fn as_ref(&self) -> &RawArray

Converts this type into a shared reference of the (usually inferred) input type.

impl Borrow<RawArray> for RawArrayBuf

fn borrow(&self) -> &RawArray

Immutably borrows from an owned value.

impl Clone for RawArrayBuf

fn clone(&self) -> RawArrayBuf

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RawArrayBuf

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

Formats the value using the given formatter.

impl Default for RawArrayBuf

fn default() -> Self

Returns the “default value” for a type.

impl Deref for RawArrayBuf

type Target = RawArray

The resulting type after dereferencing.

fn deref(&self) -> &Self::Target

Dereferences the value.

impl<'de> Deserialize<'de> for RawArrayBuf

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a> From<&'a RawArrayBuf> for Cow<'a, RawArray>

fn from(rd: &'a RawArrayBuf) -> Self

Converts to this type from the input type.

impl<'a> From<&'a RawArrayBuf> for RawBsonRef<'a>

fn from(a: &'a RawArrayBuf) -> Self

Converts to this type from the input type.

impl<'a> From<RawArrayBuf> for Cow<'a, RawArray>

fn from(rd: RawArrayBuf) -> Self

Converts to this type from the input type.

impl From<RawArrayBuf> for RawBson

fn from(a: RawArrayBuf) -> Self

Converts to this type from the input type.

impl<T: Into<RawBson>> FromIterator<T> for RawArrayBuf

fn from_iter<I: IntoIterator<Item = T>>(iter: I) -> Self

Creates a value from an iterator.

impl<'a> IntoIterator for &'a RawArrayBuf

type IntoIter = RawArrayIter<'a>

Which kind of iterator are we turning this into?

type Item = Result<RawBsonRef<'a>, Error>

The type of the elements being iterated over.

fn into_iter(self) -> RawArrayIter<'a>

Creates an iterator from a value.

impl PartialEq for RawArrayBuf

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

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

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

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

impl Serialize for RawArrayBuf

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for RawArrayBuf