1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
//! Contains functionality related to BSON binary values.
mod vector;
use std::fmt::{self, Display};
use crate::{
base64,
error::{Error, Result},
spec::BinarySubtype,
RawBinaryRef,
};
pub use vector::{PackedBitVector, Vector};
/// Represents a BSON binary value.
#[derive(Debug, Clone, Eq, PartialEq, Hash)]
pub struct Binary {
/// The subtype of the bytes.
pub subtype: BinarySubtype,
/// The binary bytes.
pub bytes: Vec<u8>,
}
impl Display for Binary {
fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
write!(
fmt,
"Binary({:#x}, {})",
u8::from(self.subtype),
base64::encode(&self.bytes)
)
}
}
impl Binary {
/// Creates a [`Binary`] from a base64 string and optional [`BinarySubtype`]. If the
/// `subtype` argument is [`None`], the [`Binary`] constructed will default to
/// [`BinarySubtype::Generic`].
///
/// ```rust
/// # use bson::{Binary, error::Result};
/// # fn example() -> Result<()> {
/// let input = base64::encode("hello");
/// let binary = Binary::from_base64(input, None)?;
/// println!("{:?}", binary);
/// // binary: Binary { subtype: Generic, bytes: [104, 101, 108, 108, 111] }
/// # Ok(())
/// # }
/// ```
pub fn from_base64(
input: impl AsRef<str>,
subtype: impl Into<Option<BinarySubtype>>,
) -> Result<Self> {
let bytes = base64::decode(input.as_ref()).map_err(Error::binary)?;
let subtype = match subtype.into() {
Some(s) => s,
None => BinarySubtype::Generic,
};
Ok(Binary { subtype, bytes })
}
#[cfg(feature = "serde")]
pub(crate) fn from_extended_doc(doc: &crate::Document) -> Option<Self> {
use std::convert::TryFrom;
let binary_doc = doc.get_document("$binary").ok()?;
if let Ok(bytes) = binary_doc.get_str("base64") {
let bytes = base64::decode(bytes).ok()?;
let subtype = binary_doc.get_str("subType").ok()?;
let subtype = hex::decode(subtype).ok()?;
if subtype.len() == 1 {
Some(Self {
bytes,
subtype: subtype[0].into(),
})
} else {
None
}
} else {
// in non-human-readable mode, RawBinary will serialize as
// { "$binary": { "bytes": <bytes>, "subType": <i32> } };
let binary = binary_doc.get_binary_generic("bytes").ok()?;
let subtype = binary_doc.get_i32("subType").ok()?;
Some(Self {
bytes: binary.clone(),
subtype: u8::try_from(subtype).ok()?.into(),
})
}
}
/// Borrow the contents as a [`RawBinaryRef`].
pub fn as_raw_binary(&self) -> RawBinaryRef<'_> {
RawBinaryRef {
bytes: self.bytes.as_slice(),
subtype: self.subtype,
}
}
}