Enum avocado::literal::Order

pub enum Order {
    Ascending,
    Descending,
}

Ordering, for specifying in which order to sort results yielded by a query.

let sorting = doc! {
    "_id": Order::Ascending,
    "zip": Order::Descending,
};
assert_eq!(sorting, doc!{
    "_id":  1,
    "zip": -1,
});

Variants

Ascending

Order smaller values first.

Descending

Order greater values first.

Trait Implementations

impl PartialOrd<Order> for Order

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

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

#[must_use] fn lt(&self, other: &Rhs) -> bool

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

#[must_use] fn le(&self, other: &Rhs) -> bool

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

#[must_use] fn gt(&self, other: &Rhs) -> bool

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

#[must_use] fn ge(&self, other: &Rhs) -> bool

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

impl From<Order> for Bson

This impl is provided so that you can use these more expressive ordering names instead of the not very clear 1 and -1 when constructing literal BSON index documents.

fn from(order: Order) -> Self

Performs the conversion.

impl Ord for Order

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

impl Copy for Order

impl Clone for Order

fn clone(&self) -> Order

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Order> for Order

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

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

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.

impl Default for Order

The default ordering is Ascending.

fn default() -> Self

Returns the "default value" for a type.

impl Debug for Order

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

Formats the value using the given formatter.

impl Hash for Order

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<'a> Deserialize<'a> for Order

let asc_i32 = Bson::I32(1);
let desc_i64 = Bson::I64(-1);
let asc_float = Bson::FloatingPoint(1.0);

let bad_i32 = Bson::I32(0);
let bad_float = Bson::FloatingPoint(-2.0);
let bad_type = Bson::from("Ascending");

assert_eq!(from_bson::<Order>(asc_i32)?, Order::Ascending);
assert_eq!(from_bson::<Order>(desc_i64)?, Order::Descending);
assert_eq!(from_bson::<Order>(asc_float)?, Order::Ascending);

assert!(from_bson::<Order>(bad_i32)
        .unwrap_err()
        .to_string()
        .contains("invalid ordering"));
assert!(from_bson::<Order>(bad_float)
        .unwrap_err()
        .to_string()
        .contains("invalid ordering"));
assert!(from_bson::<Order>(bad_type)
        .unwrap_err()
        .to_string()
        .contains("an integer expressing ordering"));

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

Deserialize this value from the given Serde deserializer.

impl Serialize for Order

assert_eq!(to_bson(&Order::Ascending)?, Bson::from(Order::Ascending));
assert_eq!(to_bson(&Order::Descending)?, Bson::from(Order::Descending));

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

Serialize this value into the given Serde serializer.