Struct avocado::prelude::ObjectId

pub struct ObjectId { /* fields omitted */ }

A wrapper around raw 12-byte ObjectId representations.

Methods

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(s: &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.

pub fn to_hex(&self) -> String

Convert the objectId to hex 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 Eq for ObjectId

impl Display for ObjectId

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl Serialize for ObjectId

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

fn from(a: ObjectId) -> Bson

Performs the conversion.

impl PartialOrd<ObjectId> 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: &ObjectId) -> bool

This method tests less than (for self and other) and is used by the < operator.

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

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

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

This method tests greater than (for self and other) and is used by the > operator.

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

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

impl Hash for ObjectId

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

Feeds this value into the given [Hasher].

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

Feeds a slice of this type into the given [Hasher].

impl Debug for ObjectId

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

Formats the value using the given formatter.

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

Compares and returns the maximum of two values.

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

Compares and returns the minimum of two values.

impl PartialEq<ObjectId> for ObjectId

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

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

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

This method tests for !=.

impl BsonSchema for ObjectId

fn bson_schema() -> OrderedDocument

Returns a BSON document describing the MongoDB-flavored schema of this type.