Enum avocado::prelude::Bson

pub enum Bson {
    FloatingPoint(f64),
    String(String),
    Array(Vec<Bson>),
    Document(OrderedDocument),
    Boolean(bool),
    Null,
    RegExp(String, String),
    JavaScriptCode(String),
    JavaScriptCodeWithScope(String, OrderedDocument),
    I32(i32),
    I64(i64),
    TimeStamp(i64),
    Binary(BinarySubtype, Vec<u8>),
    ObjectId(ObjectId),
    UtcDatetime(DateTime<Utc>),
    Symbol(String),
}

Possible BSON value types.

Variants

FloatingPoint(f64)

64-bit binary floating point

String(String)

UTF-8 string

Array(Vec<Bson>)

Array

Document(OrderedDocument)

Embedded document

Boolean(bool)

Boolean value

Null

Null value

RegExp(String, String)

Regular expression - The first cstring is the regex pattern, the second is the regex options string. Options are identified by characters, which must be stored in alphabetical order. Valid options are 'i' for case insensitive matching, 'm' for multiline matching, 'x' for verbose mode, 'l' to make \w, \W, etc. locale dependent, 's' for dotall mode ('.' matches everything), and 'u' to make \w, \W, etc. match unicode.

JavaScriptCode(String)

JavaScript code

JavaScriptCodeWithScope(String, OrderedDocument)

JavaScript code w/ scope

I32(i32)

32-bit integer

I64(i64)

64-bit integer

TimeStamp(i64)

Timestamp

Binary(BinarySubtype, Vec<u8>)

Binary data

ObjectId(ObjectId)

ObjectId

UtcDatetime(DateTime<Utc>)

UTC datetime

Symbol(String)

Symbol (Deprecated)

Methods

impl Bson

pub fn element_type(&self) -> ElementType

Get the ElementType of this value.

pub fn to_json(&self) -> Value

Deprecated since 0.5.1:

use bson.clone().into() instead

Clones the bson and returns the representative serde_json Value. The json will be in extended JSON format.

pub fn into_json(self) -> Value

Deprecated since 0.5.1:

use bson.into() instead

Consumes the bson and returns the representative serde_json Value. The json will be in extended JSON format.

pub fn from_json(val: Value) -> Bson

Deprecated since 0.5.1:

use json.into() instead

Consumes the serde_json Value and returns the representative bson. The json should be in extended JSON format.

impl Bson

Value helpers

pub fn as_f64(&self) -> Option<f64>

If Bson is FloatingPoint, return its value. Returns None otherwise

pub fn as_str(&self) -> Option<&str>

If Bson is String, return its value. Returns None otherwise

pub fn as_array(&self) -> Option<&Vec<Bson>>

If Bson is Array, return its value. Returns None otherwise

pub fn as_document(&self) -> Option<&OrderedDocument>

If Bson is Document, return its value. Returns None otherwise

pub fn as_bool(&self) -> Option<bool>

If Bson is Boolean, return its value. Returns None otherwise

pub fn as_i32(&self) -> Option<i32>

If Bson is I32, return its value. Returns None otherwise

pub fn as_i64(&self) -> Option<i64>

If Bson is I64, return its value. Returns None otherwise

pub fn as_object_id(&self) -> Option<&ObjectId>

If Bson is Objectid, return its value. Returns None otherwise

pub fn as_utc_date_time(&self) -> Option<&DateTime<Utc>>

If Bson is UtcDateTime, return its value. Returns None otherwise

pub fn as_symbol(&self) -> Option<&str>

If Bson is Symbol, return its value. Returns None otherwise

pub fn as_timestamp(&self) -> Option<i64>

If Bson is TimeStamp, return its value. Returns None otherwise

pub fn as_null(&self) -> Option<()>

If Bson is Null, return its value. Returns None otherwise

Trait Implementations

impl From<Role> for Bson

fn from(role: Role) -> Bson

Performs the conversion.

impl Clone for Bson

fn clone(&self) -> Bson

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<'de> Deserialize<'de> for Bson

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

Deserialize this value from the given Serde deserializer.

impl Serialize for Bson

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 From<Vec<Bson>> for Bson

fn from(a: Vec<Bson>) -> Bson

Performs the conversion.

impl From<i64> for Bson

fn from(a: i64) -> Bson

Performs the conversion.

impl From<ObjectId> for Bson

fn from(a: ObjectId) -> Bson

Performs the conversion.

impl From<(BinarySubtype, Vec<u8>)> for Bson

fn from((BinarySubtype, Vec<u8>)) -> Bson

Performs the conversion.

impl From<(String, String)> for Bson

fn from((String, String)) -> Bson

Performs the conversion.

impl From<u64> for Bson

fn from(a: u64) -> Bson

Performs the conversion.

impl<'a> From<&'a String> for Bson

fn from(a: &'a String) -> Bson

Performs the conversion.

impl From<bool> for Bson

fn from(a: bool) -> Bson

Performs the conversion.

impl From<f64> for Bson

fn from(a: f64) -> Bson

Performs the conversion.

impl From<(String, OrderedDocument)> for Bson

fn from((String, OrderedDocument)) -> Bson

Performs the conversion.

impl From<Value> for Bson

fn from(a: Value) -> Bson

Performs the conversion.

impl From<[u8; 12]> for Bson

fn from(a: [u8; 12]) -> Bson

Performs the conversion.

impl<'a> From<&'a str> for Bson

fn from(s: &str) -> Bson

Performs the conversion.

impl From<DateTime<Utc>> for Bson

fn from(a: DateTime<Utc>) -> Bson

Performs the conversion.

impl From<String> for Bson

fn from(a: String) -> Bson

Performs the conversion.

impl From<f32> for Bson

fn from(a: f32) -> Bson

Performs the conversion.

impl From<OrderedDocument> for Bson

fn from(a: OrderedDocument) -> Bson

Performs the conversion.

impl From<i32> for Bson

fn from(a: i32) -> Bson

Performs the conversion.

impl From<u32> for Bson

fn from(a: u32) -> Bson

Performs the conversion.

impl Default for Bson

fn default() -> Bson

Returns the "default value" for a type.

impl PartialEq<Bson> for Bson

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

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

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

This method tests for !=.

impl Display for Bson

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

Formats the value using the given formatter.

impl Debug for Bson

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

Formats the value using the given formatter.

impl<T: Doc> From<Uid<T>> for Bson where     T::Id: Into<Bson>,

fn from(uid: Uid<T>) -> Self

Performs the conversion.

impl<T: Doc, '_> From<&'_ Uid<T>> for Bson where     T::Id: ToOwned,     <T::Id as ToOwned>::Owned: Into<Bson>,

fn from(uid: &Uid<T>) -> Self

Performs the conversion.

impl From<Order> for Bson

This impl is provided so that you can use these more expressive ordering names instead of the not very clear 1 and -1 when constructing literal BSON index documents.

fn from(order: Order) -> Self

Performs the conversion.

impl From<IndexType> for Bson

fn from(index_type: IndexType) -> Self

Performs the conversion.

impl From<BsonType> for Bson

This is possible because encoding BsonType as a Bson never actually fails (the in-memory tree serializer always succeeds unless the value being serialized itself provokes an error, which our BsonType doesn't.)

fn from(bson_type: BsonType) -> Self

Performs the conversion.

impl From<RegexOpts> for Bson

See the explanation for BsonType as to why this impl is possible.

fn from(options: RegexOpts) -> Self

Performs the conversion.

impl From<DateTimeType> for Bson

See the explanation for BsonType as to why this impl is possible.

fn from(ty: DateTimeType) -> Self

Performs the conversion.