Struct ObjectId

pub struct ObjectId { /* private fields */ }

A wrapper around a raw 12-byte ObjectId.

serde integration

When serialized to BSON via serde, this type produces a BSON ObjectId. In non-BSON formats, it will serialize to and deserialize from that format’s equivalent of the extended JSON representation of a BSON ObjectId.

ObjectIds can be deserialized from hex strings in all formats.

e.g.

use serde::{Serialize, Deserialize};
use bson::oid::ObjectId;

#[derive(Serialize, Deserialize)]
struct Foo {
    oid: ObjectId,
}

let f = Foo { oid: ObjectId::new() };
println!("bson: {}", bson::to_document(&f)?);
println!("json: {}", serde_json::to_string(&f)?);

Produces the following output:

bson: { "oid": ObjectId("63ceed18f71dda7d8cf21e8e") }
json: {"oid":{"$oid":"63ceed18f71dda7d8cf21e8e"}}

serde_helpers

The bson crate provides a number of useful helpers for serializing and deserializing various types to and from different formats. For example, to serialize an ObjectId as a hex string, you can use crate::serde_helpers::serialize_object_id_as_hex_string. Check out the crate::serde_helpers module documentation for a list of all of the helpers offered by the crate.

e.g.

use serde::{Serialize, Deserialize};
use bson::oid::ObjectId;

#[derive(Serialize, Deserialize)]
struct Foo {
    // Serializes as a BSON ObjectId or extJSON in non-BSON formats
    oid: ObjectId,

    // Serializes as a hex string in all formats
    #[serde(serialize_with = "bson::serde_helpers::serialize_object_id_as_hex_string")]
    oid_as_hex: ObjectId,
}
let f = Foo { oid: ObjectId::new(), oid_as_hex: ObjectId::new() };
println!("bson: {}", bson::to_document(&f)?);
println!("json: {}", serde_json::to_string(&f)?);

Produces the following output:

bson: { "oid": ObjectId("63ceeffd37518221cdc6cda2"), "oid_as_hex": "63ceeffd37518221cdc6cda3" }
json: {"oid":{"$oid":"63ceeffd37518221cdc6cda2"},"oid_as_hex":"63ceeffd37518221cdc6cda3"}

Implementations

impl ObjectId

pub fn new() -> Self

Generates a new ObjectId, represented in bytes. See the docs for more information.

pub const fn from_bytes(bytes: [u8; 12]) -> ObjectId

Constructs a new ObjectId wrapper around the raw byte representation.

pub fn from_parts( seconds_since_epoch: u32, process_id: [u8; 5], counter: [u8; 3], ) -> Self

Construct an ObjectId from its parts. See the docs for more information.

pub fn parse_str(s: impl AsRef<str>) -> Result<ObjectId>

Creates an ObjectID using a 12-byte (24-char) hexadecimal string.

pub fn timestamp(&self) -> DateTime

Retrieves the timestamp from an ObjectId.

pub const fn bytes(&self) -> [u8; 12]

Returns the raw byte representation of an ObjectId.

pub fn to_hex(self) -> String

Convert this ObjectId to its hex string representation.

Trait Implementations

impl Clone for ObjectId

fn clone(&self) -> ObjectId

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for ObjectId

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

Formats the value using the given formatter.

impl Default for ObjectId

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for ObjectId

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

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for ObjectId

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

Formats the value using the given formatter.

impl From<[u8; 12]> for ObjectId

fn from(bytes: [u8; 12]) -> Self

Converts to this type from the input type.

impl From<ObjectId> for Bson

fn from(a: ObjectId) -> Bson

Converts to this type from the input type.

impl From<ObjectId> for RawBson

fn from(oid: ObjectId) -> Self

Converts to this type from the input type.

impl From<ObjectId> for RawBsonRef<'_>

fn from(oid: ObjectId) -> Self

Converts to this type from the input type.

impl FromStr for ObjectId

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl Hash for ObjectId

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for ObjectId

fn cmp(&self, other: &ObjectId) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for ObjectId

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl PartialOrd for ObjectId

fn partial_cmp(&self, other: &ObjectId) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for ObjectId

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

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for ObjectId

impl Eq for ObjectId

impl StructuralPartialEq for ObjectId