Struct bson::raw::RawArray

#[repr(transparent)]
pub struct RawArray { /* private fields */ }

A slice of a BSON document containing a BSON array value (akin to std::str). This can be retrieved from a RawDocument via RawDocument::get.

This is an unsized type, meaning that it must always be used behind a pointer like &.

Accessing elements within a RawArray is similar to element access in crate::Document, but because the contents are parsed during iteration instead of at creation time, format errors can happen at any time during use.

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

use bson::{doc, raw::RawDocument};

let doc = doc! {
    "x": [1, true, "two", 5.5]
};
let bytes = bson::to_vec(&doc)?;

let rawdoc = RawDocument::from_bytes(bytes.as_slice())?;
let rawarray = rawdoc.get_array("x")?;

for v in rawarray {
    println!("{:?}", v?);
}

Individual elements can be accessed using 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 array from the beginning to find the requested index.

use bson::{doc, raw::RawDocument};

let doc = doc! {
    "x": [1, true, "two", 5.5]
};
let bytes = bson::to_vec(&doc)?;

let rawdoc = RawDocument::from_bytes(bytes.as_slice())?;
let rawarray = rawdoc.get_array("x")?;

assert_eq!(rawarray.get_bool(1)?, true);

Implementations

impl 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 Debug for RawArray

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

Formats the value using the given formatter.

impl<'de: 'a, 'a> Deserialize<'de> for &'a RawArray

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 RawArray> for Cow<'a, RawArray>

fn from(rdr: &'a RawArray) -> Self

Converts to this type from the input type.

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

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

Converts to this type from the input type.

impl<'a> IntoIterator for &'a RawArray

type IntoIter = RawArrayIter<'a>

Which kind of iterator are we turning this into?

type Item = Result<RawBsonRef<'a>>

The type of the elements being iterated over.

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

Creates an iterator from a value.

impl PartialEq<RawArray> for RawArray

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

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

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

This method tests for !=.

impl<'a> Serialize for &'a RawArray

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

Serialize this value into the given Serde serializer.

impl ToOwned for RawArray

type Owned = RawArrayBuf

The resulting type after obtaining ownership.

fn to_owned(&self) -> Self::Owned

Creates owned data from borrowed data, usually by cloning.

fn clone_into(&self, target: &mut Self::Owned)

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

Uses borrowed data to replace owned data, usually by cloning.

impl TryFrom<&'_ RawArray> for Vec<Bson>

type Error = Error

The type returned in the event of a conversion error.

fn try_from(arr: &RawArray) -> Result<Vec<Bson>>

Performs the conversion.

impl StructuralPartialEq for RawArray