Struct ObjectId

pub struct ObjectId(/* private fields */);

A wrapper around raw 12-byte ObjectId representations.

Implementations

impl ObjectId

pub fn new() -> Result<ObjectId, Error>

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

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

Constructs a new ObjectId wrapper around the raw byte representation.

pub fn with_string(oid: &str) -> Result<ObjectId, Error>

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

pub fn with_timestamp(time: u32) -> ObjectId

Creates a dummy ObjectId with a specific generation time. This method should only be used to do range queries on a field containing ObjectId instances.

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

Returns the raw byte representation of an ObjectId.

pub fn timestamp(&self) -> u32

Retrieves the timestamp (seconds since epoch) from an ObjectId.

pub fn machine_id(&self) -> u32

Retrieves the machine id associated with an ObjectId.

pub fn process_id(&self) -> u16

Retrieves the process id associated with an ObjectId.

pub fn counter(&self) -> u32

Retrieves the increment counter from an ObjectId.

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 Decodable for ObjectId

fn decode<D: Decoder>(d: &mut D) -> Result<Self, D::Error>

Deserialize a value using a Decoder.

impl Display for ObjectId

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

Formats the value using the given formatter.

impl Encodable for ObjectId

fn encode<S: Encoder>(&self, s: &mut S) -> Result<(), S::Error>

Serialize a value using an Encoder.

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 ToHex for ObjectId

fn to_hex(&self) -> String

Converts the value of self to a hex value, returning the owned string.

impl Eq for ObjectId

impl StructuralPartialEq for ObjectId