Enum bson::Bson

pub enum Bson {
    Double(f64),
    String(String),
    Array(Array),
    Document(Document),
    Boolean(bool),
    Null,
    RegularExpression(Regex),
    JavaScriptCode(String),
    JavaScriptCodeWithScope(JavaScriptCodeWithScope),
    Int32(i32),
    Int64(i64),
    Timestamp(Timestamp),
    Binary(Binary),
    ObjectId(ObjectId),
    DateTime(DateTime<Utc>),
    Symbol(String),
    Decimal128(Decimal128),
    Undefined,
    MaxKey,
    MinKey,
    DbPointer(DbPointer),
}

Possible BSON value types.

Variants

Double(f64)

64-bit binary floating point

String(String)

UTF-8 string

Array(Array)

Array

Document(Document)

Embedded document

Boolean(bool)

Boolean value

Null

Null value

RegularExpression(Regex)

Regular expression

JavaScriptCode(String)

JavaScript code

JavaScriptCodeWithScope(JavaScriptCodeWithScope)

JavaScript code w/ scope

Int32(i32)

32-bit signed integer

Int64(i64)

64-bit signed integer

Timestamp(Timestamp)

Timestamp

Binary(Binary)

Binary data

ObjectId(ObjectId)

ObjectId

DateTime(DateTime<Utc>)

UTC datetime

Symbol(String)

Symbol (Deprecated)

Decimal128(Decimal128)

128-bit decimal floating point

Undefined

Undefined value (Deprecated)

MaxKey

Max key

MinKey

Min key

DbPointer(DbPointer)

DBPointer (Deprecated)

Implementations

impl Bson

pub fn into_relaxed_extjson(self) -> Value

Converts the Bson value into its relaxed extended JSON representation.

Note: extended json encoding for Decimal128 values is not supported without the "decimal128" feature flag. If this method is called on a case which contains a Decimal128 value, it will panic.

pub fn into_canonical_extjson(self) -> Value

Converts the Bson value into its canonical extended JSON representation.

Note: extended json encoding for Decimal128 values is not supported without the "decimal128" feature flag. If this method is called on a case which contains a Decimal128 value, it will panic.

pub fn element_type(&self) -> ElementType

Get the ElementType of this value.

impl Bson

Value helpers

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

If Bson is Double, return its value as an f64. Returns None otherwise

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

If Bson is String, return its value as a &str. Returns None otherwise

pub fn as_str_mut(&mut self) -> Option<&mut str>

If Bson is String, return a mutable reference to its value as a str. Returns None otherwise

pub fn as_array(&self) -> Option<&Array>

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

pub fn as_array_mut(&mut self) -> Option<&mut Array>

If Bson is Array, return a mutable reference to its value. Returns None otherwise

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

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

pub fn as_document_mut(&mut self) -> Option<&mut Document>

If Bson is Document, return a mutable reference to its value. Returns None otherwise

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

If Bson is Bool, 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_object_id_mut(&mut self) -> Option<&mut ObjectId>

If Bson is Objectid, return a mutable reference to its value. Returns None otherwise

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

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

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

If Bson is DateTime, return a mutable reference to 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_symbol_mut(&mut self) -> Option<&mut str>

If Bson is Symbol, return a mutable reference to its value. Returns None otherwise

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

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

pub fn as_db_pointer(&self) -> Option<&DbPointer>

Trait Implementations

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 Debug for Bson

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

Formats the value using the given formatter.

impl Default for Bson

fn default() -> Self

Returns the "default value" for a type.

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

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

Deserialize this value from the given Serde deserializer.

impl Display for Bson

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

Formats the value using the given formatter.

impl<'_, T> From<&'_ [T]> for Bson where
    T: Clone + Into<Bson>, 

fn from(s: &[T]) -> Bson

Performs the conversion.

impl<'_, T> From<&'_ T> for Bson where
    T: Clone + Into<Bson>, 

fn from(t: &T) -> Bson

Performs the conversion.

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

fn from(s: &str) -> Bson

Performs the conversion.

impl From<[u8; 12]> for Bson

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

Performs the conversion.

impl From<Binary> for Bson

fn from(binary: Binary) -> Bson

Performs the conversion.

impl From<Bson> for Value

This will create the relaxed Extended JSON v2 representation of the provided Bson.

fn from(bson: Bson) -> Self

Performs the conversion.

impl From<DateTime<Utc>> for Bson

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

Performs the conversion.

impl From<DbPointer> for Bson

fn from(a: DbPointer) -> Bson

Performs the conversion.

impl From<Document> for Bson

fn from(a: Document) -> Bson

Performs the conversion.

impl From<JavaScriptCodeWithScope> for Bson

fn from(code_with_scope: JavaScriptCodeWithScope) -> Bson

Performs the conversion.

impl From<ObjectId> for Bson

fn from(a: ObjectId) -> Bson

Performs the conversion.

impl From<Regex> for Bson

fn from(regex: Regex) -> Bson

Performs the conversion.

impl From<String> for Bson

fn from(a: String) -> Bson

Performs the conversion.

impl From<Timestamp> for Bson

fn from(ts: Timestamp) -> Bson

Performs the conversion.

impl<T> From<Vec<T>> for Bson where
    T: Into<Bson>, 

fn from(v: Vec<T>) -> Bson

Performs the conversion.

impl From<bool> for Bson

fn from(a: bool) -> Bson

Performs the conversion.

impl From<f32> for Bson

fn from(a: f32) -> Bson

Performs the conversion.

impl From<f64> for Bson

fn from(a: f64) -> Bson

Performs the conversion.

impl From<i32> for Bson

fn from(a: i32) -> Bson

Performs the conversion.

impl From<i64> for Bson

fn from(a: i64) -> Bson

Performs the conversion.

impl From<u32> for Bson

fn from(a: u32) -> Bson

Performs the conversion.

impl From<u64> for Bson

fn from(a: u64) -> Bson

Performs the conversion.

impl<T: Into<Bson>> FromIterator<T> for Bson

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

Examples

use std::iter::FromIterator;
use bson::Bson;

let x: Bson = Bson::from_iter(vec!["lorem", "ipsum", "dolor"]);
// or
let x: Bson = vec!["lorem", "ipsum", "dolor"].into_iter().collect();

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 Serialize for Bson

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 Bson

impl TryFrom<Map<String, Value>> for Bson

This converts from the input JSON object as if it were MongoDB Extended JSON v2.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(obj: Map<String, Value>) -> Result<Self>

Performs the conversion.

impl TryFrom<Value> for Bson

This converts from the input JSON as if it were MongoDB Extended JSON v2.

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: Value) -> Result<Self>

Performs the conversion.