Struct avocado::literal::BsonType

pub struct BsonType { /* fields omitted */ }

Non-deprecated BSON types. For use with the $type operator.

let queries = bson!([
    { "$type": BsonType::OBJECT_ID },
    { "$type": [ BsonType::STRING, BsonType::default() ] },
]);
assert_eq!(queries, bson!([{ "$type": "objectId" },
                           { "$type": ["string", "null"] }]));

Methods

impl BsonType

pub const NULL: BsonType

The null value.

pub const BOOL: BsonType

true or false.

pub const DOUBLE: BsonType

Double-precision floating-point number.

pub const INT: BsonType

32-bit signed integer.

pub const LONG: BsonType

64-bit signed integer.

pub const DECIMAL: BsonType

128-bit decimal number.

pub const NUMBER: BsonType

Any of the 4 numeric types (double, int, long, decimal).

pub const OBJECT_ID: BsonType

ObjectId.

pub const TIMESTAMP: BsonType

Timestamp.

pub const DATE: BsonType

Date and time.

pub const STRING: BsonType

String.

pub const REGEX: BsonType

Regular expression and its matching options.

pub const BINARY: BsonType

Binary data, BLOB.

pub const ARRAY: BsonType

Array.

pub const DOCUMENT: BsonType

Document or object.

pub const JAVASCRIPT: BsonType

JavaScript code.

pub const JAVASCRIPT_WITH_SCOPE: BsonType

JavaScript code with scope.

pub fn empty() -> BsonType

Returns an empty set of flags.

pub fn all() -> BsonType

Returns the set containing all flags.

pub fn bits(&self) -> u16

Returns the raw value of the flags currently stored.

pub fn from_bits(bits: u16) -> Option<BsonType>

Convert from underlying bit representation, unless that representation contains bits that do not correspond to a flag.

pub fn from_bits_truncate(bits: u16) -> BsonType

Convert from underlying bit representation, dropping any bits that do not correspond to flags.

pub fn is_empty(&self) -> bool

Returns true if no flags are currently stored.

pub fn is_all(&self) -> bool

Returns true if all flags are currently set.

pub fn intersects(&self, other: BsonType) -> bool

Returns true if there are flags common to both self and other.

pub fn contains(&self, other: BsonType) -> bool

Returns true all of the flags in other are contained within self.

pub fn insert(&mut self, other: BsonType)

Inserts the specified flags in-place.

pub fn remove(&mut self, other: BsonType)

Removes the specified flags in-place.

pub fn toggle(&mut self, other: BsonType)

Toggles the specified flags in-place.

pub fn set(&mut self, other: BsonType, value: bool)

Inserts or removes the specified flags depending on the passed value.

Trait Implementations

impl From<BsonType> for Bson

This is possible because encoding BsonType as a Bson never actually fails (the in-memory tree serializer always succeeds unless the value being serialized itself provokes an error, which our BsonType doesn't.)

fn from(bson_type: BsonType) -> Self

Performs the conversion.

impl Eq for BsonType

impl Extend<BsonType> for BsonType

fn extend<T: IntoIterator<Item = BsonType>>(&mut self, iterator: T)

Extends a collection with the contents of an iterator.

impl PartialOrd<BsonType> for BsonType

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

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

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

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

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

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

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

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

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

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

impl Copy for BsonType

impl Default for BsonType

The default BSON type is null.

fn default() -> Self

Returns the "default value" for a type.

impl PartialEq<BsonType> for BsonType

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

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

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

This method tests for !=.

impl Clone for BsonType

fn clone(&self) -> BsonType

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Ord for BsonType

fn cmp(&self, other: &BsonType) -> 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 Binary for BsonType

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

Formats the value using the given formatter.

impl Debug for BsonType

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

Formats the value using the given formatter.

impl UpperHex for BsonType

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

Formats the value using the given formatter.

impl LowerHex for BsonType

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

Formats the value using the given formatter.

impl Octal for BsonType

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

Formats the value using the given formatter.

impl Hash for BsonType

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,

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

impl Sub<BsonType> for BsonType

type Output = BsonType

The resulting type after applying the - operator.

fn sub(self, other: BsonType) -> BsonType

Returns the set difference of the two sets of flags.

impl SubAssign<BsonType> for BsonType

fn sub_assign(&mut self, other: BsonType)

Disables all flags enabled in the set.

impl Not for BsonType

type Output = BsonType

The resulting type after applying the ! operator.

fn not(self) -> BsonType

Returns the complement of this set of flags.

impl BitAnd<BsonType> for BsonType

type Output = BsonType

The resulting type after applying the & operator.

fn bitand(self, other: BsonType) -> BsonType

Returns the intersection between the two sets of flags.

impl BitOr<BsonType> for BsonType

type Output = BsonType

The resulting type after applying the | operator.

fn bitor(self, other: BsonType) -> BsonType

Returns the union of the two sets of flags.

impl BitXor<BsonType> for BsonType

type Output = BsonType

The resulting type after applying the ^ operator.

fn bitxor(self, other: BsonType) -> BsonType

Returns the left flags, but with all the right flags toggled.

impl BitAndAssign<BsonType> for BsonType

fn bitand_assign(&mut self, other: BsonType)

Disables all flags disabled in the set.

impl BitOrAssign<BsonType> for BsonType

fn bitor_assign(&mut self, other: BsonType)

Adds the set of flags.

impl BitXorAssign<BsonType> for BsonType

fn bitxor_assign(&mut self, other: BsonType)

Toggles the set of flags.

impl FromIterator<BsonType> for BsonType

fn from_iter<T: IntoIterator<Item = BsonType>>(iterator: T) -> BsonType

Creates a value from an iterator.

impl<'a> Deserialize<'a> for BsonType

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

Deserialize this value from the given Serde deserializer.

impl Serialize for BsonType

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

Serialize this value into the given Serde serializer.